AWS Fundamentals Logo
AWS Fundamentals
AWS::MSK::Cluster

MSK Cluster

Resource Type definition for AWS::MSK::Cluster

Properties

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

Filter:
PropertyTypeFlags
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

Return Values

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

AttributeTypeDescription
Arnstring-
CurrentVersionstringThe 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:DescribeKey

update

kafka:UpdateMonitoringkafka:UpdateClusterKafkaVersionkafka:UpdateClusterConfigurationkafka:UpdateBrokerTypekafka:UpdateBrokerCountkafka:UpdateBrokerStoragekafka:UpdateStoragekafka:UpdateSecurity

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
Properties15
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