Skip to content
v2.277.0

Experimental

@aws-cdk/aws-msk-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

KafkaVersion Class ​

Kafka cluster version.

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,
  }),
});
python
# vpc: ec2.Vpc

cluster = msk.Cluster(self, "cluster",
    cluster_name="myCluster",
    kafka_version=msk.KafkaVersion.V4_1_X_KRAFT,
    vpc=vpc,
    encryption_in_transit=msk.EncryptionInTransitConfig(
        client_broker=msk.ClientBrokerEncryption.TLS
    ),
    client_authentication=msk.ClientAuthentication.sasl(
        scram=True
    )
)
java
Vpc vpc;

Cluster cluster = Cluster.Builder.create(this, "cluster")
        .clusterName("myCluster")
        .kafkaVersion(KafkaVersion.V4_1_X_KRAFT)
        .vpc(vpc)
        .encryptionInTransit(EncryptionInTransitConfig.builder()
                .clientBroker(ClientBrokerEncryption.TLS)
                .build())
        .clientAuthentication(ClientAuthentication.sasl(SaslAuthProps.builder()
                .scram(true)
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.MSK.Alpha
Vpc vpc;

var cluster = new Cluster(this, "cluster", new ClusterProps {
    ClusterName = "myCluster",
    KafkaVersion = KafkaVersion.V4_1_X_KRAFT,
    Vpc = vpc,
    EncryptionInTransit = new EncryptionInTransitConfig {
        ClientBroker = ClientBrokerEncryption.TLS
    },
    ClientAuthentication = ClientAuthentication.Sasl(new SaslAuthProps {
        Scram = true
    })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkmskalpha/v2
var vpc Vpc

cluster := msk.NewCluster(this, jsii.String("cluster"), &ClusterProps{
	ClusterName: jsii.String("myCluster"),
	KafkaVersion: msk.KafkaVersion_V4_1_X_KRAFT(),
	Vpc: Vpc,
	EncryptionInTransit: &EncryptionInTransitConfig{
		ClientBroker: msk.ClientBrokerEncryption_TLS,
	},
	ClientAuthentication: msk.ClientAuthentication_Sasl(&SaslAuthProps{
		Scram: jsii.Boolean(true),
	}),
})

Properties ​

featuresmay be undefinedKafkaVersionFeaturesfeaturesmay be undefinedKafkaVersionFeaturesfeaturesmay be undefinedKafkaVersionFeaturesFeaturesmay be undefinedKafkaVersionFeaturesFeaturesmay be undefinedKafkaVersionFeatures #
features for the cluster version.
V1_1_1KafkaVersionV1_1_1KafkaVersionV1_1_1KafkaVersionV1_1_1KafkaVersionV1_1_1KafkaVersion static deprecated #
use the latest runtime instead

Kafka version 1.1.1

V2_1_0KafkaVersionV2_1_0KafkaVersionV2_1_0KafkaVersionV2_1_0KafkaVersionV2_1_0KafkaVersion static deprecated #
use the latest runtime instead

Kafka version 2.1.0

V2_2_1KafkaVersionV2_2_1KafkaVersionV2_2_1KafkaVersionV2_2_1KafkaVersionV2_2_1KafkaVersion static deprecated #
use the latest runtime instead
V2_3_1KafkaVersionV2_3_1KafkaVersionV2_3_1KafkaVersionV2_3_1KafkaVersionV2_3_1KafkaVersion static deprecated #
use the latest runtime instead
V2_4_1KafkaVersionV2_4_1KafkaVersionV2_4_1KafkaVersionV2_4_1KafkaVersionV2_4_1KafkaVersion static deprecated #
use the latest runtime instead

Kafka version 2.4.1

V2_4_1_1KafkaVersionV2_4_1_1KafkaVersionV2_4_1_1KafkaVersionV2_4_1_1KafkaVersionV2_4_1_1KafkaVersion static deprecated #
use the latest runtime instead
V2_5_1KafkaVersionV2_5_1KafkaVersionV2_5_1KafkaVersionV2_5_1KafkaVersionV2_5_1KafkaVersion static deprecated #
use the latest runtime instead
V2_6_0KafkaVersionV2_6_0KafkaVersionV2_6_0KafkaVersionV2_6_0KafkaVersionV2_6_0KafkaVersion static deprecated #
use the latest runtime instead
V2_6_1KafkaVersionV2_6_1KafkaVersionV2_6_1KafkaVersionV2_6_1KafkaVersionV2_6_1KafkaVersion static deprecated #
use the latest runtime instead
V2_6_2KafkaVersionV2_6_2KafkaVersionV2_6_2KafkaVersionV2_6_2KafkaVersionV2_6_2KafkaVersion static deprecated #
use the latest runtime instead
V2_6_3KafkaVersionV2_6_3KafkaVersionV2_6_3KafkaVersionV2_6_3KafkaVersionV2_6_3KafkaVersion static deprecated #
use the latest runtime instead
V2_7_0KafkaVersionV2_7_0KafkaVersionV2_7_0KafkaVersionV2_7_0KafkaVersionV2_7_0KafkaVersion static deprecated #
use the latest runtime instead
V2_7_1KafkaVersionV2_7_1KafkaVersionV2_7_1KafkaVersionV2_7_1KafkaVersionV2_7_1KafkaVersion static deprecated #
use the latest runtime instead
V2_7_2KafkaVersionV2_7_2KafkaVersionV2_7_2KafkaVersionV2_7_2KafkaVersionV2_7_2KafkaVersion static deprecated #
use the latest runtime instead
V2_8_0KafkaVersionV2_8_0KafkaVersionV2_8_0KafkaVersionV2_8_0KafkaVersionV2_8_0KafkaVersion static deprecated #
use the latest runtime instead
V2_8_1KafkaVersionV2_8_1KafkaVersionV2_8_1KafkaVersionV2_8_1KafkaVersionV2_8_1KafkaVersion static deprecated #
use the latest runtime instead
V2_8_2_TIEREDKafkaVersionV2_8_2_TIEREDKafkaVersionV2_8_2_TIEREDKafkaVersionV2_8_2_TIEREDKafkaVersionV2_8_2_TIEREDKafkaVersion static deprecated #
use the latest runtime instead
V3_1_1KafkaVersionV3_1_1KafkaVersionV3_1_1KafkaVersionV3_1_1KafkaVersionV3_1_1KafkaVersion static deprecated #
use the latest runtime instead
V3_2_0KafkaVersionV3_2_0KafkaVersionV3_2_0KafkaVersionV3_2_0KafkaVersionV3_2_0KafkaVersion static deprecated #
use the latest runtime instead
V3_3_1KafkaVersionV3_3_1KafkaVersionV3_3_1KafkaVersionV3_3_1KafkaVersionV3_3_1KafkaVersion static deprecated #
use the latest runtime instead
V3_3_2KafkaVersionV3_3_2KafkaVersionV3_3_2KafkaVersionV3_3_2KafkaVersionV3_3_2KafkaVersion static deprecated #
use the latest runtime instead
Kafka version 3.4.0.
Kafka version 3.5.1.
Kafka version 3.6.0.
Kafka version 3.7.x with ZooKeeper metadata mode support.
V3_7_X_KRAFTKafkaVersionV3_7_X_KRAFTKafkaVersionV3_7_X_KRAFTKafkaVersionV3_7_X_KRAFTKafkaVersionV3_7_X_KRAFTKafkaVersion static #
Kafka version 3.7.x with KRaft (Apache Kafka Raft) metadata mode support.
Kafka version 3.8.x with ZooKeeper metadata mode support.
V3_8_X_KRAFTKafkaVersionV3_8_X_KRAFTKafkaVersionV3_8_X_KRAFTKafkaVersionV3_8_X_KRAFTKafkaVersionV3_8_X_KRAFTKafkaVersion static #
Kafka version 3.8.x with KRaft (Apache Kafka Raft) metadata mode support.
Kafka version 3.9.x with ZooKeeper metadata mode support.
V3_9_X_KRAFTKafkaVersionV3_9_X_KRAFTKafkaVersionV3_9_X_KRAFTKafkaVersionV3_9_X_KRAFTKafkaVersionV3_9_X_KRAFTKafkaVersion static #
Kafka version 3.9.x with KRaft (Apache Kafka Raft) metadata mode support.
V4_0_X_KRAFTKafkaVersionV4_0_X_KRAFTKafkaVersionV4_0_X_KRAFTKafkaVersionV4_0_X_KRAFTKafkaVersionV4_0_X_KRAFTKafkaVersion static #
Kafka version 4.0.x with KRaft (Apache Kafka Raft) metadata mode support.
V4_1_X_KRAFTKafkaVersionV4_1_X_KRAFTKafkaVersionV4_1_X_KRAFTKafkaVersionV4_1_X_KRAFTKafkaVersionV4_1_X_KRAFTKafkaVersion static #
Kafka version 4.1.x with KRaft (Apache Kafka Raft) metadata mode support.
V4_2_X_KRAFTKafkaVersionV4_2_X_KRAFTKafkaVersionV4_2_X_KRAFTKafkaVersionV4_2_X_KRAFTKafkaVersionV4_2_X_KRAFTKafkaVersion static #
Kafka version 4.2.x with KRaft (Apache Kafka Raft) metadata mode support.

Currently only supported on MSK Express brokers.

versionstringversionstrversionStringVersionstringVersion*string #
cluster version number.

Methods ​

isTieredStorageCompatible(): booleandef is_tiered_storage_compatible(self, ) -> boolpublic Boolean isTieredStorageCompatible()public bool IsTieredStorageCompatible()func IsTieredStorageCompatible() *bool #
Checks if the cluster version supports tiered storage mode.
of(version: string, features?: KafkaVersionFeatures): KafkaVersion // chainable@staticmethod def of(version: str, features: typing.Optional[KafkaVersionFeatures] = None) -> KafkaVersionpublic static KafkaVersion of(String version, KafkaVersionFeatures features)public static KafkaVersion Of(string version, KafkaVersionFeatures? features = null)func Of(Version *string, Features KafkaVersionFeatures) KafkaVersion static #
Custom cluster version.
1 parameter

Parameters

  • versionversionversionversionVersion — custom version number.