interface ClusterProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MSK.ClusterProps
Java	software.amazon.awscdk.services.msk.ClusterProps
Python	aws_cdk.aws_msk.ClusterProps
TypeScript (source)	@aws-cdk/aws-msk » ClusterProps

Properties for a MSK Cluster.

Example

declare const vpc: ec2.Vpc;
const cluster = new msk.Cluster(this, 'cluster', {
  clusterName: 'myCluster',
  kafkaVersion: msk.KafkaVersion.V2_8_1,
  vpc,
  encryptionInTransit: {
    clientBroker: msk.ClientBrokerEncryption.TLS,
  },
  clientAuthentication: msk.ClientAuthentication.sasl({
    scram: true,
  }),
});

Properties

Name	Type	Description
clusterName🔹	string	The physical name of the cluster.
kafkaVersion🔹	KafkaVersion	The version of Apache Kafka.
vpc🔹	IVpc	Defines the virtual networking environment for this cluster.
clientAuthentication?🔹	ClientAuthentication	Configuration properties for client authentication.
configurationInfo?🔹	ClusterConfigurationInfo	The Amazon MSK configuration to use for the cluster.
ebsStorageInfo?🔹	EbsStorageInfo	Information about storage volumes attached to MSK broker nodes.
encryptionInTransit?🔹	EncryptionInTransitConfig	Config details for encryption in transit.
instanceType?🔹	InstanceType	The EC2 instance type that you want Amazon MSK to use when it creates your brokers.
logging?🔹	BrokerLogging	Configure your MSK cluster to send broker logs to different destination types.
monitoring?🔹	MonitoringConfiguration	Cluster monitoring configuration.
numberOfBrokerNodes?🔹	number	Number of Apache Kafka brokers deployed in each Availability Zone.
removalPolicy?🔹	RemovalPolicy	What to do when this resource is deleted from a stack.
securityGroups?🔹	ISecurityGroup[]	The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.
vpcSubnets?🔹	SubnetSelection	Where to place the nodes within the VPC.

---

clusterName🔹

Type: string

The physical name of the cluster.

---

kafkaVersion🔹

Type: KafkaVersion

The version of Apache Kafka.

---

vpc🔹

Type: IVpc

Defines the virtual networking environment for this cluster.

Must have at least 2 subnets in two different AZs.

---

clientAuthentication?🔹

Type: ClientAuthentication (optional, default: disabled)

Configuration properties for client authentication.

MSK supports using private TLS certificates or SASL/SCRAM to authenticate the identity of clients.

---

configurationInfo?🔹

Type: ClusterConfigurationInfo (optional, default: none)

The Amazon MSK configuration to use for the cluster.

---

ebsStorageInfo?🔹

Type: EbsStorageInfo (optional, default: 1000 GiB EBS volume)

Information about storage volumes attached to MSK broker nodes.

---

encryptionInTransit?🔹

Type: EncryptionInTransitConfig (optional, default: enabled)

Config details for encryption in transit.

---

instanceType?🔹

Type: InstanceType (optional, default: kafka.m5.large)

The EC2 instance type that you want Amazon MSK to use when it creates your brokers.

See also: https://docs.aws.amazon.com/msk/latest/developerguide/msk-create-cluster.html#broker-instance-types

---

logging?🔹

Type: BrokerLogging (optional, default: disabled)

Configure your MSK cluster to send broker logs to different destination types.

---

monitoring?🔹

Type: MonitoringConfiguration (optional, default: DEFAULT monitoring level)

Cluster monitoring configuration.

---

numberOfBrokerNodes?🔹

Type: number (optional, default: 1)

Number of Apache Kafka brokers deployed in each Availability Zone.

---

removalPolicy?🔹

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

What to do when this resource is deleted from a stack.

---

securityGroups?🔹

Type: ISecurityGroup[] (optional, default: create new security group)

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.

---

vpcSubnets?🔹

Type: SubnetSelection (optional, default: the Vpc default strategy if not specified.)

Where to place the nodes within the VPC.

Amazon MSK distributes the broker nodes evenly across the subnets that you specify. The subnets that you specify must be in distinct Availability Zones. Client subnets can't be in Availability Zone us-east-1e.