Experimental
@aws-cdk/aws-msk-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ClusterProps Struct
Properties for a MSK Cluster.
Example
ts
declare const vpc: ec2.Vpc;
const cluster = new msk.Cluster(this, 'cluster', {
clusterName: 'myCluster',
kafkaVersion: msk.KafkaVersion.V4_1_X_KRAFT,
vpc,
encryptionInTransit: {
clientBroker: msk.ClientBrokerEncryption.TLS,
},
clientAuthentication: msk.ClientAuthentication.sasl({
scram: true,
}),
});
Properties
brokerTypeoptionalBrokerTypebroker_typeoptionalBrokerTypebrokerTypeoptionalBrokerTypeBrokerTypeoptionalBrokerTypeBrokerTypeoptionalBrokerType= BrokerType.STANDARD#The broker type for the cluster.
When set to EXPRESS, the cluster will be created with Express Brokers. When this is set to EXPRESS, instanceType must also be specified.
clientAuthenticationoptionalClientAuthenticationclient_authenticationoptionalClientAuthenticationclientAuthenticationoptionalClientAuthenticationClientAuthenticationoptionalClientAuthenticationClientAuthenticationoptionalClientAuthentication= disabled#Configuration properties for client authentication.
MSK supports using private TLS certificates or SASL/SCRAM to authenticate the identity of clients.
The physical name of the cluster.
configurationInfooptionalClusterConfigurationInfoconfiguration_infooptionalClusterConfigurationInfoconfigurationInfooptionalClusterConfigurationInfoConfigurationInfooptionalClusterConfigurationInfoConfigurationInfooptionalClusterConfigurationInfo= none#The Amazon MSK configuration to use for the cluster.
ebsStorageInfooptionalEbsStorageInfoebs_storage_infooptionalEbsStorageInfoebsStorageInfooptionalEbsStorageInfoEbsStorageInfooptionalEbsStorageInfoEbsStorageInfooptionalEbsStorageInfo#Information about storage volumes attached to MSK broker nodes.
Default: 1000 GiB EBS volume
encryptionInTransitoptionalEncryptionInTransitConfigencryption_in_transitoptionalEncryptionInTransitConfigencryptionInTransitoptionalEncryptionInTransitConfigEncryptionInTransitoptionalEncryptionInTransitConfigEncryptionInTransitoptionalEncryptionInTransitConfig= enabled#Config details for encryption in transit.
instanceTypeoptionalInstanceTypeinstance_typeoptionalInstanceTypeinstanceTypeoptionalInstanceTypeInstanceTypeoptionalInstanceTypeInstanceTypeoptionalInstanceType= kafka.m5.large#The EC2 instance type that you want Amazon MSK to use when it creates your brokers.
kafkaVersionKafkaVersionkafka_versionKafkaVersionkafkaVersionKafkaVersionKafkaVersionKafkaVersionKafkaVersionKafkaVersionrequired#The version of Apache Kafka.
loggingoptionalBrokerLoggingloggingoptionalBrokerLoggingloggingoptionalBrokerLoggingLoggingoptionalBrokerLoggingLoggingoptionalBrokerLogging= disabled#Configure your MSK cluster to send broker logs to different destination types.
monitoringoptionalMonitoringConfigurationmonitoringoptionalMonitoringConfigurationmonitoringoptionalMonitoringConfigurationMonitoringoptionalMonitoringConfigurationMonitoringoptionalMonitoringConfiguration#Cluster monitoring configuration.
Default: DEFAULT monitoring level
numberOfBrokerNodesoptionalnumbernumber_of_broker_nodesoptionalint | floatnumberOfBrokerNodesoptionalNumberNumberOfBrokerNodesoptionaldoubleNumberOfBrokerNodesoptional*float64= 1#Number of Apache Kafka brokers deployed in each Availability Zone.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAIN#What to do when this resource is deleted from a stack.
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]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.
Default: create new security group
storageModeoptionalStorageModestorage_modeoptionalStorageModestorageModeoptionalStorageModeStorageModeoptionalStorageModeStorageModeoptionalStorageMode= StorageMode.LOCAL#This controls storage mode for supported storage tiers.
Defines the virtual networking environment for this cluster.
Must have at least 2 subnets in two different AZs.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#Where to place the nodes within the VPC.
Default: the Vpc default strategy if not specified.
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.