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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:11.271Z")
@Stability(Stable)
public class CfnCluster
extends CfnResource
implements IInspectable, ITaggable

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

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	Example:
static interface	CfnCluster.BrokerNodeGroupInfoProperty	Example:
static final class	CfnCluster.Builder	A fluent builder for CfnCluster.
static interface	CfnCluster.ClientAuthenticationProperty	Example:
static interface	CfnCluster.CloudWatchLogsProperty	Example:
static interface	CfnCluster.ConfigurationInfoProperty	Example:
static interface	CfnCluster.ConnectivityInfoProperty	Example:
static interface	CfnCluster.EBSStorageInfoProperty	Example:
static interface	CfnCluster.EncryptionAtRestProperty	Example:
static interface	CfnCluster.EncryptionInfoProperty	Example:
static interface	CfnCluster.EncryptionInTransitProperty	Example:
static interface	CfnCluster.FirehoseProperty	Example:
static interface	CfnCluster.IamProperty	Example:
static interface	CfnCluster.JmxExporterProperty	Example:
static interface	CfnCluster.LoggingInfoProperty	Example:
static interface	CfnCluster.NodeExporterProperty	Example:
static interface	CfnCluster.OpenMonitoringProperty	Example:
static interface	CfnCluster.PrometheusProperty	Example:
static interface	CfnCluster.ProvisionedThroughputProperty	Example:
static interface	CfnCluster.PublicAccessProperty	Example:
static interface	CfnCluster.S3Property	Example:
static interface	CfnCluster.SaslProperty	Example:
static interface	CfnCluster.ScramProperty	Example:
static interface	CfnCluster.StorageInfoProperty	Example:
static interface	CfnCluster.TlsProperty	Example:
static interface	CfnCluster.UnauthenticatedProperty	Example:
static interface	CfnCluster.VpcConnectivityClientAuthenticationProperty	Example:
static interface	CfnCluster.VpcConnectivityIamProperty	Example:
static interface	CfnCluster.VpcConnectivityProperty	Example:
static interface	CfnCluster.VpcConnectivitySaslProperty	Example:
static interface	CfnCluster.VpcConnectivityScramProperty	Example:
static interface	CfnCluster.VpcConnectivityTlsProperty	Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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()
Object	getBrokerNodeGroupInfo()
protected Map<String,Object>	getCfnProperties()
Object	getClientAuthentication()
String	getClusterName()
Object	getConfigurationInfo()
String	getCurrentVersion()	The current version of the MSK cluster.
Object	getEncryptionInfo()
String	getEnhancedMonitoring()
String	getKafkaVersion()
Object	getLoggingInfo()
Number	getNumberOfBrokerNodes()
Object	getOpenMonitoring()
String	getStorageMode()
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Map<String,String>	getTagsRaw()	A key-value pair to associate with a resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBrokerNodeGroupInfo(IResolvable value)
void	setBrokerNodeGroupInfo(CfnCluster.BrokerNodeGroupInfoProperty value)
void	setClientAuthentication(IResolvable value)
void	setClientAuthentication(CfnCluster.ClientAuthenticationProperty value)
void	setClusterName(String value)
void	setConfigurationInfo(IResolvable value)
void	setConfigurationInfo(CfnCluster.ConfigurationInfoProperty value)
void	setCurrentVersion(String value)	The current version of the MSK cluster.
void	setEncryptionInfo(IResolvable value)
void	setEncryptionInfo(CfnCluster.EncryptionInfoProperty value)
void	setEnhancedMonitoring(String value)
void	setKafkaVersion(String value)
void	setLoggingInfo(IResolvable value)
void	setLoggingInfo(CfnCluster.LoggingInfoProperty value)
void	setNumberOfBrokerNodes(Number value)
void	setOpenMonitoring(IResolvable value)
void	setOpenMonitoring(CfnCluster.OpenMonitoringProperty value)
void	setStorageMode(String value)
void	setTagsRaw(Map<String,String> value)	A key-value pair to associate with a resource.

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.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()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

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()

setBrokerNodeGroupInfo

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

setBrokerNodeGroupInfo

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

getClusterName

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

setClusterName

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

getKafkaVersion

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

setKafkaVersion

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

getNumberOfBrokerNodes

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

setNumberOfBrokerNodes

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

getClientAuthentication

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

setClientAuthentication

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

setClientAuthentication

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

getConfigurationInfo

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

setConfigurationInfo

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

setConfigurationInfo

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

getCurrentVersion

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

The current version of the MSK cluster.

setCurrentVersion

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

The current version of the MSK cluster.

getEncryptionInfo

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

setEncryptionInfo

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

setEncryptionInfo

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

getEnhancedMonitoring

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

setEnhancedMonitoring

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

getLoggingInfo

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

setLoggingInfo

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

setLoggingInfo

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

getOpenMonitoring

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

setOpenMonitoring

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

setOpenMonitoring

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

getStorageMode

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

setStorageMode

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

getTagsRaw

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

A key-value pair to associate with a resource.

setTagsRaw

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

A key-value pair to associate with a resource.