AWS::MSK::Cluster

MSK Cluster

Resource Type definition for AWS::MSK::Cluster

Properties

14 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`BrokerNodeGroupInfo`	`BrokerNodeGroupInfo`	Required
`ClusterName`	`string`	RequiredCreate-only
`KafkaVersion`	`string`	Required
`NumberOfBrokerNodes`	`integer`	Required
`ClientAuthentication`	`ClientAuthentication`
`ConfigurationInfo`	`ConfigurationInfo`
`EncryptionInfo`	`EncryptionInfo`
`EnhancedMonitoring`	`string`
`LoggingInfo`	`LoggingInfo`
`OpenMonitoring`	`OpenMonitoring`
`Rebalancing`	`Rebalancing`
`StorageMode`	`string`
`Tags`	`object`
`ZookeeperAccess`	`ZookeeperAccess`	Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	-
`CurrentVersion`	`string`	The current version of the MSK cluster

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::MSK::Cluster

Resources:
  MyResource:
    Type: AWS::MSK::Cluster
    Properties:
      BrokerNodeGroupInfo: "value"
      KafkaVersion: "value"
      NumberOfBrokerNodes: 1
      ClusterName: "my-clustername"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcsiam:AttachRolePolicyiam:CreateServiceLinkedRoleiam:PutRolePolicykms:CreateGrantkms:DescribeKeykafka:CreateClusterkafka:DescribeClusterkafka:TagResourcelogs:CreateLogDeliverylogs:GetLogDeliverylogs:UpdateLogDeliverylogs:DeleteLogDeliverylogs:ListLogDeliveriess3:GetBucketPolicys3:PutBucketPolicylogs:PutResourcePolicylogs:DescribeResourcePolicieslogs:DescribeLogGroupsfirehose:TagDeliveryStreamacm-pca:GetCertificateAuthorityCertificate

update

kafka:UpdateMonitoringkafka:UpdateClusterKafkaVersionkafka:UpdateClusterConfigurationkafka:UpdateBrokerTypekafka:UpdateBrokerCountkafka:UpdateBrokerStoragekafka:UpdateStoragekafka:UpdateSecuritykafka:UpdateConnectivitykafka:UpdateRebalancingkafka:DescribeClusterkafka:DescribeClusterOperationkafka:TagResourcekafka:UntagResourceec2:CreateTagsec2:DescribeSubnetsec2:DescribeVpcsec2:DescribeSecurityGroupsec2:DescribeRouteTablesiam:AttachRolePolicyiam:CreateServiceLinkedRoleiam:PutRolePolicykms:DescribeKeykms:CreateGrantlogs:CreateLogDeliverylogs:GetLogDeliverylogs:UpdateLogDeliverylogs:DeleteLogDeliverylogs:ListLogDeliveriess3:GetBucketPolicylogs:PutResourcePolicylogs:DescribeResourcePolicieslogs:DescribeLogGroupsfirehose:TagDeliveryStreamacm-pca:GetCertificateAuthorityCertificate

delete

kafka:DeleteClusterkafka:DescribeCluster

list

kafka:ListClusters

read

kafka:DescribeCluster

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceMSK

Properties16

Required4

TaggingSupported

Primary IDArn

Supported Operations

CreateUpdateDeleteListRead

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

BrokerNodeGroupInfo/BrokerAZDistributionBrokerNodeGroupInfo/ClientSubnetsBrokerNodeGroupInfo/SecurityGroupsEncryptionInfo/EncryptionAtRestEncryptionInfo/EncryptionInTransit/InClusterClusterName

Related Resources

External Links

AWS Documentation