Interface CfnClusterProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnClusterProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-12T17:54:17.601Z")
@Stability(Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnCluster.
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.*;
CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
.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())
.rebalancing(RebalancingProperty.builder()
.status("status")
.build())
.storageMode("storageMode")
.tags(Map.of(
"tagsKey", "tags"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnClusterPropsstatic final classAn implementation forCfnClusterProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnClusterProps.Builderbuilder()Information about the broker nodes in the cluster.default ObjectIncludes all client authentication related information.The name of the cluster.default ObjectRepresents the configuration that you want MSK to use for the cluster.default Stringdefault ObjectIncludes all encryption-related information.default StringSpecifies the level of monitoring for the MSK cluster.The version of Apache Kafka.default ObjectLogging info details for the cluster.The number of broker nodes in the cluster.default ObjectThe settings for open monitoring.default ObjectReturns union: eitherIResolvableorCfnCluster.RebalancingPropertydefault StringThis controls storage mode for supported storage tiers.getTags()An arbitrary set of tags (key-value pairs) for the cluster.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBrokerNodeGroupInfo
Information about the broker nodes in the cluster.Returns union: either
IResolvableorCfnCluster.BrokerNodeGroupInfoProperty- See Also:
-
getClusterName
The name of the cluster.- See Also:
-
getKafkaVersion
The version of Apache Kafka.You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
- See Also:
-
getNumberOfBrokerNodes
The number of broker nodes in the cluster.- See Also:
-
getClientAuthentication
Includes all client authentication related information.Returns union: either
IResolvableorCfnCluster.ClientAuthenticationProperty- See Also:
-
getConfigurationInfo
Represents the configuration that you want MSK to use for the cluster.Returns union: either
IResolvableorCfnCluster.ConfigurationInfoProperty- See Also:
-
getCurrentVersion
- See Also:
-
getEncryptionInfo
Includes all encryption-related information.Returns union: either
IResolvableorCfnCluster.EncryptionInfoProperty- See Also:
-
getEnhancedMonitoring
Specifies the level of monitoring for the MSK cluster.- See Also:
-
getLoggingInfo
Logging info details for the cluster.Returns union: either
IResolvableorCfnCluster.LoggingInfoProperty- See Also:
-
getOpenMonitoring
The settings for open monitoring.Returns union: either
IResolvableorCfnCluster.OpenMonitoringProperty- See Also:
-
getRebalancing
Returns union: eitherIResolvableorCfnCluster.RebalancingProperty- See Also:
-
getStorageMode
This controls storage mode for supported storage tiers.- See Also:
-
getTags
An arbitrary set of tags (key-value pairs) for the cluster.- See Also:
-
builder
- Returns:
- a
CfnClusterProps.BuilderofCfnClusterProps
-