Package software.amazon.awscdk.services.msk

Class CfnCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.msk.CfnCluster

All Implemented Interfaces:

IInspectable, ITaggable, IClusterRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:15.946Z")
@Stability(Stable)
public class CfnCluster
extends CfnResource
implements IInspectable, IClusterRef, ITaggable

Creates a new MSK cluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.msk.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .brokerNodeGroupInfo(BrokerNodeGroupInfoProperty.builder()
                 .clientSubnets(List.of("clientSubnets"))
                 .instanceType("instanceType")
                 // the properties below are optional
                 .brokerAzDistribution("brokerAzDistribution")
                 .connectivityInfo(ConnectivityInfoProperty.builder()
                         .publicAccess(PublicAccessProperty.builder()
                                 .type("type")
                                 .build())
                         .vpcConnectivity(VpcConnectivityProperty.builder()
                                 .clientAuthentication(VpcConnectivityClientAuthenticationProperty.builder()
                                         .sasl(VpcConnectivitySaslProperty.builder()
                                                 .iam(VpcConnectivityIamProperty.builder()
                                                         .enabled(false)
                                                         .build())
                                                 .scram(VpcConnectivityScramProperty.builder()
                                                         .enabled(false)
                                                         .build())
                                                 .build())
                                         .tls(VpcConnectivityTlsProperty.builder()
                                                 .enabled(false)
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .securityGroups(List.of("securityGroups"))
                 .storageInfo(StorageInfoProperty.builder()
                         .ebsStorageInfo(EBSStorageInfoProperty.builder()
                                 .provisionedThroughput(ProvisionedThroughputProperty.builder()
                                         .enabled(false)
                                         .volumeThroughput(123)
                                         .build())
                                 .volumeSize(123)
                                 .build())
                         .build())
                 .build())
         .clusterName("clusterName")
         .kafkaVersion("kafkaVersion")
         .numberOfBrokerNodes(123)
         // the properties below are optional
         .clientAuthentication(ClientAuthenticationProperty.builder()
                 .sasl(SaslProperty.builder()
                         .iam(IamProperty.builder()
                                 .enabled(false)
                                 .build())
                         .scram(ScramProperty.builder()
                                 .enabled(false)
                                 .build())
                         .build())
                 .tls(TlsProperty.builder()
                         .certificateAuthorityArnList(List.of("certificateAuthorityArnList"))
                         .enabled(false)
                         .build())
                 .unauthenticated(UnauthenticatedProperty.builder()
                         .enabled(false)
                         .build())
                 .build())
         .configurationInfo(ConfigurationInfoProperty.builder()
                 .arn("arn")
                 .revision(123)
                 .build())
         .currentVersion("currentVersion")
         .encryptionInfo(EncryptionInfoProperty.builder()
                 .encryptionAtRest(EncryptionAtRestProperty.builder()
                         .dataVolumeKmsKeyId("dataVolumeKmsKeyId")
                         .build())
                 .encryptionInTransit(EncryptionInTransitProperty.builder()
                         .clientBroker("clientBroker")
                         .inCluster(false)
                         .build())
                 .build())
         .enhancedMonitoring("enhancedMonitoring")
         .loggingInfo(LoggingInfoProperty.builder()
                 .brokerLogs(BrokerLogsProperty.builder()
                         .cloudWatchLogs(CloudWatchLogsProperty.builder()
                                 .enabled(false)
                                 // the properties below are optional
                                 .logGroup("logGroup")
                                 .build())
                         .firehose(FirehoseProperty.builder()
                                 .enabled(false)
                                 // the properties below are optional
                                 .deliveryStream("deliveryStream")
                                 .build())
                         .s3(S3Property.builder()
                                 .enabled(false)
                                 // the properties below are optional
                                 .bucket("bucket")
                                 .prefix("prefix")
                                 .build())
                         .build())
                 .build())
         .openMonitoring(OpenMonitoringProperty.builder()
                 .prometheus(PrometheusProperty.builder()
                         .jmxExporter(JmxExporterProperty.builder()
                                 .enabledInBroker(false)
                                 .build())
                         .nodeExporter(NodeExporterProperty.builder()
                                 .enabledInBroker(false)
                                 .build())
                         .build())
                 .build())
         .storageMode("storageMode")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnCluster.BrokerLogsProperty	The broker logs configuration for this MSK cluster.
static interface	CfnCluster.BrokerNodeGroupInfoProperty	Describes the setup to be used for the broker nodes in the cluster.
static final class	CfnCluster.Builder	A fluent builder for CfnCluster.
static interface	CfnCluster.ClientAuthenticationProperty	Example:
static interface	CfnCluster.CloudWatchLogsProperty	Details of the CloudWatch Logs destination for broker logs.
static interface	CfnCluster.ConfigurationInfoProperty	Specifies the configuration to use for the brokers.
static interface	CfnCluster.ConnectivityInfoProperty	Broker access controls.
static interface	CfnCluster.EBSStorageInfoProperty	Contains information about the EBS storage volumes attached to the broker nodes.
static interface	CfnCluster.EncryptionAtRestProperty	The data-volume encryption details.
static interface	CfnCluster.EncryptionInfoProperty	Includes encryption-related information, such as the Amazon KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.
static interface	CfnCluster.EncryptionInTransitProperty	The settings for encrypting data in transit.
static interface	CfnCluster.FirehoseProperty	Firehose details for BrokerLogs.
static interface	CfnCluster.IamProperty	Details for SASL/IAM client authentication.
static interface	CfnCluster.JmxExporterProperty	Indicates whether you want to enable or disable the JMX Exporter.
static interface	CfnCluster.LoggingInfoProperty	You can configure your MSK cluster to send broker logs to different destination types.
static interface	CfnCluster.NodeExporterProperty	Indicates whether you want to enable or disable the Node Exporter.
static interface	CfnCluster.OpenMonitoringProperty	JMX and Node monitoring for the MSK cluster.
static interface	CfnCluster.PrometheusProperty	Prometheus settings for open monitoring.
static interface	CfnCluster.ProvisionedThroughputProperty	Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
static interface	CfnCluster.PublicAccessProperty	Broker access controls.
static interface	CfnCluster.S3Property	The details of the Amazon S3 destination for broker logs.
static interface	CfnCluster.SaslProperty	Details for client authentication using SASL.
static interface	CfnCluster.ScramProperty	Details for SASL/SCRAM client authentication.
static interface	CfnCluster.StorageInfoProperty	Contains information about storage volumes attached to Amazon MSK broker nodes.
static interface	CfnCluster.TlsProperty	Details for client authentication using TLS.
static interface	CfnCluster.UnauthenticatedProperty	Details for allowing no client authentication.
static interface	CfnCluster.VpcConnectivityClientAuthenticationProperty	Includes all client authentication information for VpcConnectivity.
static interface	CfnCluster.VpcConnectivityIamProperty	Details for SASL/IAM client authentication for VpcConnectivity.
static interface	CfnCluster.VpcConnectivityProperty	VPC connection control settings for brokers.
static interface	CfnCluster.VpcConnectivitySaslProperty	Details for client authentication using SASL for VpcConnectivity.
static interface	CfnCluster.VpcConnectivityScramProperty	Details for SASL/SCRAM client authentication for VpcConnectivity.
static interface	CfnCluster.VpcConnectivityTlsProperty	Details for client authentication using TLS for VpcConnectivity.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.msk.IClusterRef

IClusterRef.Jsii$Default, IClusterRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCluster(software.constructs.Construct scope, String id, CfnClusterProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the MSK cluster.
Object	getBrokerNodeGroupInfo()	Information about the broker nodes in the cluster.
protected Map<String,Object>	getCfnProperties()
Object	getClientAuthentication()	Includes all client authentication related information.
String	getClusterName()	The name of the cluster.
ClusterReference	getClusterRef()	A reference to a Cluster resource.
Object	getConfigurationInfo()	Represents the configuration that you want MSK to use for the cluster.
String	getCurrentVersion()	The version of the cluster that you want to update.
Object	getEncryptionInfo()	Includes all encryption-related information.
String	getEnhancedMonitoring()	Specifies the level of monitoring for the MSK cluster.
String	getKafkaVersion()	The version of Apache Kafka.
Object	getLoggingInfo()	Logging info details for the cluster.
Number	getNumberOfBrokerNodes()	The number of broker nodes in the cluster.
Object	getOpenMonitoring()	The settings for open monitoring.
String	getStorageMode()	This controls storage mode for supported storage tiers.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Map<String,String>	getTagsRaw()	An arbitrary set of tags (key-value pairs) for the cluster.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBrokerNodeGroupInfo(IResolvable value)	Information about the broker nodes in the cluster.
void	setBrokerNodeGroupInfo(CfnCluster.BrokerNodeGroupInfoProperty value)	Information about the broker nodes in the cluster.
void	setClientAuthentication(IResolvable value)	Includes all client authentication related information.
void	setClientAuthentication(CfnCluster.ClientAuthenticationProperty value)	Includes all client authentication related information.
void	setClusterName(String value)	The name of the cluster.
void	setConfigurationInfo(IResolvable value)	Represents the configuration that you want MSK to use for the cluster.
void	setConfigurationInfo(CfnCluster.ConfigurationInfoProperty value)	Represents the configuration that you want MSK to use for the cluster.
void	setCurrentVersion(String value)	The version of the cluster that you want to update.
void	setEncryptionInfo(IResolvable value)	Includes all encryption-related information.
void	setEncryptionInfo(CfnCluster.EncryptionInfoProperty value)	Includes all encryption-related information.
void	setEnhancedMonitoring(String value)	Specifies the level of monitoring for the MSK cluster.
void	setKafkaVersion(String value)	The version of Apache Kafka.
void	setLoggingInfo(IResolvable value)	Logging info details for the cluster.
void	setLoggingInfo(CfnCluster.LoggingInfoProperty value)	Logging info details for the cluster.
void	setNumberOfBrokerNodes(Number value)	The number of broker nodes in the cluster.
void	setOpenMonitoring(IResolvable value)	The settings for open monitoring.
void	setOpenMonitoring(CfnCluster.OpenMonitoringProperty value)	The settings for open monitoring.
void	setStorageMode(String value)	This controls storage mode for supported storage tiers.
void	setTagsRaw(Map<String,String> value)	An arbitrary set of tags (key-value pairs) for the cluster.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCluster

@Stability(Stable)
public CfnCluster(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnClusterProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the MSK cluster.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClusterRef

@Stability(Stable)
@NotNull
public ClusterReference getClusterRef()

A reference to a Cluster resource.

Specified by:

getClusterRef in interface IClusterRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getBrokerNodeGroupInfo

@Stability(Stable)
@NotNull
public Object getBrokerNodeGroupInfo()

Information about the broker nodes in the cluster.

setBrokerNodeGroupInfo

@Stability(Stable)
public void setBrokerNodeGroupInfo(@NotNull
 IResolvable value)

Information about the broker nodes in the cluster.

setBrokerNodeGroupInfo

@Stability(Stable)
public void setBrokerNodeGroupInfo(@NotNull
 CfnCluster.BrokerNodeGroupInfoProperty value)

Information about the broker nodes in the cluster.

getClusterName

@Stability(Stable)
@NotNull
public String getClusterName()

The name of the cluster.

setClusterName

@Stability(Stable)
public void setClusterName(@NotNull
 String value)

The name of the cluster.

getKafkaVersion

@Stability(Stable)
@NotNull
public String getKafkaVersion()

The version of Apache Kafka.

setKafkaVersion

@Stability(Stable)
public void setKafkaVersion(@NotNull
 String value)

The version of Apache Kafka.

getNumberOfBrokerNodes

@Stability(Stable)
@NotNull
public Number getNumberOfBrokerNodes()

The number of broker nodes in the cluster.

setNumberOfBrokerNodes

@Stability(Stable)
public void setNumberOfBrokerNodes(@NotNull
 Number value)

The number of broker nodes in the cluster.

getClientAuthentication

@Stability(Stable)
@Nullable
public Object getClientAuthentication()

Includes all client authentication related information.

setClientAuthentication

@Stability(Stable)
public void setClientAuthentication(@Nullable
 IResolvable value)

Includes all client authentication related information.

setClientAuthentication

@Stability(Stable)
public void setClientAuthentication(@Nullable
 CfnCluster.ClientAuthenticationProperty value)

Includes all client authentication related information.

getConfigurationInfo

@Stability(Stable)
@Nullable
public Object getConfigurationInfo()

Represents the configuration that you want MSK to use for the cluster.

setConfigurationInfo

@Stability(Stable)
public void setConfigurationInfo(@Nullable
 IResolvable value)

Represents the configuration that you want MSK to use for the cluster.

setConfigurationInfo

@Stability(Stable)
public void setConfigurationInfo(@Nullable
 CfnCluster.ConfigurationInfoProperty value)

Represents the configuration that you want MSK to use for the cluster.

getCurrentVersion

@Stability(Stable)
@Nullable
public String getCurrentVersion()

The version of the cluster that you want to update.

setCurrentVersion

@Stability(Stable)
public void setCurrentVersion(@Nullable
 String value)

The version of the cluster that you want to update.

getEncryptionInfo

@Stability(Stable)
@Nullable
public Object getEncryptionInfo()

Includes all encryption-related information.

setEncryptionInfo

@Stability(Stable)
public void setEncryptionInfo(@Nullable
 IResolvable value)

Includes all encryption-related information.

setEncryptionInfo

@Stability(Stable)
public void setEncryptionInfo(@Nullable
 CfnCluster.EncryptionInfoProperty value)

Includes all encryption-related information.

getEnhancedMonitoring

@Stability(Stable)
@Nullable
public String getEnhancedMonitoring()

Specifies the level of monitoring for the MSK cluster.

setEnhancedMonitoring

@Stability(Stable)
public void setEnhancedMonitoring(@Nullable
 String value)

Specifies the level of monitoring for the MSK cluster.

getLoggingInfo

@Stability(Stable)
@Nullable
public Object getLoggingInfo()

Logging info details for the cluster.

setLoggingInfo

@Stability(Stable)
public void setLoggingInfo(@Nullable
 IResolvable value)

Logging info details for the cluster.

setLoggingInfo

@Stability(Stable)
public void setLoggingInfo(@Nullable
 CfnCluster.LoggingInfoProperty value)

Logging info details for the cluster.

getOpenMonitoring

@Stability(Stable)
@Nullable
public Object getOpenMonitoring()

The settings for open monitoring.

setOpenMonitoring

@Stability(Stable)
public void setOpenMonitoring(@Nullable
 IResolvable value)

The settings for open monitoring.

setOpenMonitoring

@Stability(Stable)
public void setOpenMonitoring(@Nullable
 CfnCluster.OpenMonitoringProperty value)

The settings for open monitoring.

getStorageMode

@Stability(Stable)
@Nullable
public String getStorageMode()

This controls storage mode for supported storage tiers.

setStorageMode

@Stability(Stable)
public void setStorageMode(@Nullable
 String value)

This controls storage mode for supported storage tiers.

getTagsRaw

@Stability(Stable)
@Nullable
public Map<String,String> getTagsRaw()

An arbitrary set of tags (key-value pairs) for the cluster.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Map<String,String> value)

An arbitrary set of tags (key-value pairs) for the cluster.