AWS CDK Reference

Appearance

v2.274.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.

Stability
Experimental
Source
lib/cluster-version.ts

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 ​

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_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead

Kafka version 1.1.1

V2_1_0KafkaVersionv2_1_0KafkaVersionV2_1_0KafkaVersionV2_1_0KafkaVersionV2_1_0KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead

Kafka version 2.1.0

V2_2_1KafkaVersionv2_2_1KafkaVersionV2_2_1KafkaVersionV2_2_1KafkaVersionV2_2_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_3_1KafkaVersionv2_3_1KafkaVersionV2_3_1KafkaVersionV2_3_1KafkaVersionV2_3_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_4_1KafkaVersionv2_4_1KafkaVersionV2_4_1KafkaVersionV2_4_1KafkaVersionV2_4_1KafkaVersionrequiredstaticdeprecated#
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_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_5_1KafkaVersionv2_5_1KafkaVersionV2_5_1KafkaVersionV2_5_1KafkaVersionV2_5_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_6_0KafkaVersionv2_6_0KafkaVersionV2_6_0KafkaVersionV2_6_0KafkaVersionV2_6_0KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_6_1KafkaVersionv2_6_1KafkaVersionV2_6_1KafkaVersionV2_6_1KafkaVersionV2_6_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_6_2KafkaVersionv2_6_2KafkaVersionV2_6_2KafkaVersionV2_6_2KafkaVersionV2_6_2KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_6_3KafkaVersionv2_6_3KafkaVersionV2_6_3KafkaVersionV2_6_3KafkaVersionV2_6_3KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_7_0KafkaVersionv2_7_0KafkaVersionV2_7_0KafkaVersionV2_7_0KafkaVersionV2_7_0KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_7_1KafkaVersionv2_7_1KafkaVersionV2_7_1KafkaVersionV2_7_1KafkaVersionV2_7_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_7_2KafkaVersionv2_7_2KafkaVersionV2_7_2KafkaVersionV2_7_2KafkaVersionV2_7_2KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_8_0KafkaVersionv2_8_0KafkaVersionV2_8_0KafkaVersionV2_8_0KafkaVersionV2_8_0KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_8_1KafkaVersionv2_8_1KafkaVersionV2_8_1KafkaVersionV2_8_1KafkaVersionV2_8_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V2_8_2_TIEREDKafkaVersionv2_8_2_tieredKafkaVersionV2_8_2_TIEREDKafkaVersionV2_8_2_TIEREDKafkaVersionV2_8_2_TIEREDKafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V3_1_1KafkaVersionv3_1_1KafkaVersionV3_1_1KafkaVersionV3_1_1KafkaVersionV3_1_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V3_2_0KafkaVersionv3_2_0KafkaVersionV3_2_0KafkaVersionV3_2_0KafkaVersionV3_2_0KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V3_3_1KafkaVersionv3_3_1KafkaVersionV3_3_1KafkaVersionV3_3_1KafkaVersionV3_3_1KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V3_3_2KafkaVersionv3_3_2KafkaVersionV3_3_2KafkaVersionV3_3_2KafkaVersionV3_3_2KafkaVersionrequiredstaticdeprecated#
use the latest runtime instead
V3_4_0KafkaVersionv3_4_0KafkaVersionV3_4_0KafkaVersionV3_4_0KafkaVersionV3_4_0KafkaVersionrequiredstatic#
Kafka version 3.4.0.
V3_5_1KafkaVersionv3_5_1KafkaVersionV3_5_1KafkaVersionV3_5_1KafkaVersionV3_5_1KafkaVersionrequiredstatic#
Kafka version 3.5.1.
V3_6_0KafkaVersionv3_6_0KafkaVersionV3_6_0KafkaVersionV3_6_0KafkaVersionV3_6_0KafkaVersionrequiredstatic#
Kafka version 3.6.0.
V3_7_XKafkaVersionv3_7_xKafkaVersionV3_7_XKafkaVersionV3_7_XKafkaVersionV3_7_XKafkaVersionrequiredstatic#
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_KRAFTKafkaVersionrequiredstatic#
Kafka version 3.7.x with KRaft (Apache Kafka Raft) metadata mode support.
V3_8_XKafkaVersionv3_8_xKafkaVersionV3_8_XKafkaVersionV3_8_XKafkaVersionV3_8_XKafkaVersionrequiredstatic#
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_KRAFTKafkaVersionrequiredstatic#
Kafka version 3.8.x with KRaft (Apache Kafka Raft) metadata mode support.
V3_9_XKafkaVersionv3_9_xKafkaVersionV3_9_XKafkaVersionV3_9_XKafkaVersionV3_9_XKafkaVersionrequiredstatic#
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_KRAFTKafkaVersionrequiredstatic#
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_KRAFTKafkaVersionrequiredstatic#
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_KRAFTKafkaVersionrequiredstatic#
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_KRAFTKafkaVersionrequiredstatic#
Kafka version 4.2.x with KRaft (Apache Kafka Raft) metadata mode support.

Currently only supported on MSK Express brokers.

versionstringversionstrversionStringVersionstringVersion*stringrequired#
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) KafkaVersionstatic#
Custom cluster version.
1 parameter

Parameters

  • versionversionversionversionVersion — custom version number.