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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.979Z")
 @Stability(value=Stable)
public class CfnCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MSK::Cluster`.

The AWS::MSK::Cluster resource creates an Amazon MSK cluster . For more information, see What Is Amazon MSK? in the Amazon MSK Developer Guide .

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())
                         .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())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnCluster.BrokerLogsProperty You can configure your Amazon MSK cluster to send broker logs to different destination types.
static interface	CfnCluster.BrokerNodeGroupInfoProperty The setup to be used for brokers in the cluster.
static class	CfnCluster.Builder A fluent builder for CfnCluster.
static interface	CfnCluster.ClientAuthenticationProperty Includes information related to client authentication.
static interface	CfnCluster.CloudWatchLogsProperty Details of the CloudWatch Logs destination for broker logs.
static interface	CfnCluster.ConfigurationInfoProperty Specifies the Amazon MSK configuration to use for the brokers.
static interface	CfnCluster.ConnectivityInfoProperty Specifies whether the cluster's brokers are publicly accessible.
static interface	CfnCluster.EBSStorageInfoProperty Contains information about the EBS storage volumes attached to brokers.
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 Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.
static interface	CfnCluster.IamProperty Details for IAM access control.
static interface	CfnCluster.JmxExporterProperty Indicates whether you want to enable or disable the JMX Exporter.
static interface	CfnCluster.LoggingInfoProperty You can configure your Amazon 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 Specifies whether provisioned throughput is turned on and the volume throughput target.
static interface	CfnCluster.PublicAccessProperty Specifies whether the cluster's brokers are accessible from the internet.
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 MSK broker nodes.
static interface	CfnCluster.TlsProperty Details for client authentication using TLS.
static interface	CfnCluster.UnauthenticatedProperty Details for allowing no client authentication.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCluster(software.constructs.Construct scope, String id, CfnClusterProps props) Create a new `AWS::MSK::Cluster`.
protected	CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
Object	getBrokerNodeGroupInfo() The setup to be used for brokers in the cluster.
protected Map<String,Object>	getCfnProperties()
Object	getClientAuthentication() Includes information related to client authentication.
String	getClusterName() The name of the cluster.
Object	getConfigurationInfo() The Amazon MSK configuration 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() You can configure your Amazon MSK cluster to send broker logs to different destination types.
Number	getNumberOfBrokerNodes() The number of broker nodes you want in the Amazon MSK cluster.
Object	getOpenMonitoring() The settings for open monitoring.
TagManager	getTags() A map of key:value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBrokerNodeGroupInfo(CfnCluster.BrokerNodeGroupInfoProperty value) The setup to be used for brokers in the cluster.
void	setBrokerNodeGroupInfo(IResolvable value) The setup to be used for brokers in the cluster.
void	setClientAuthentication(CfnCluster.ClientAuthenticationProperty value) Includes information related to client authentication.
void	setClientAuthentication(IResolvable value) Includes information related to client authentication.
void	setClusterName(String value) The name of the cluster.
void	setConfigurationInfo(CfnCluster.ConfigurationInfoProperty value) The Amazon MSK configuration to use for the cluster.
void	setConfigurationInfo(IResolvable value) The Amazon MSK configuration to use for the cluster.
void	setCurrentVersion(String value) The version of the cluster that you want to update.
void	setEncryptionInfo(CfnCluster.EncryptionInfoProperty value) Includes all encryption-related information.
void	setEncryptionInfo(IResolvable 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(CfnCluster.LoggingInfoProperty value) You can configure your Amazon MSK cluster to send broker logs to different destination types.
void	setLoggingInfo(IResolvable value) You can configure your Amazon MSK cluster to send broker logs to different destination types.
void	setNumberOfBrokerNodes(Number value) The number of broker nodes you want in the Amazon MSK cluster.
void	setOpenMonitoring(CfnCluster.OpenMonitoringProperty value) The settings for open monitoring.
void	setOpenMonitoring(IResolvable value) The settings for open monitoring.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCluster

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

CfnCluster

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

CfnCluster

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

Create a new `AWS::MSK::Cluster`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

A map of key:value pairs to apply to this resource.

Both key and value are of type String.

getBrokerNodeGroupInfo

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

The setup to be used for brokers in the cluster.

AWS CloudFormation may replace the cluster when you update certain BrokerNodeGroupInfo properties. To understand the update behavior for your use case, you should review the child properties for BrokerNodeGroupInfo .

setBrokerNodeGroupInfo

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

The setup to be used for brokers in the cluster.

AWS CloudFormation may replace the cluster when you update certain BrokerNodeGroupInfo properties. To understand the update behavior for your use case, you should review the child properties for BrokerNodeGroupInfo .

setBrokerNodeGroupInfo

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

The setup to be used for brokers in the cluster.

AWS CloudFormation may replace the cluster when you update certain BrokerNodeGroupInfo properties. To understand the update behavior for your use case, you should review the child properties for BrokerNodeGroupInfo .

getClusterName

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

The name of the cluster.

setClusterName

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

The name of the cluster.

getKafkaVersion

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

The version of Apache Kafka.

For more information, see Supported Apache Kafka versions in the Amazon MSK Developer Guide.

setKafkaVersion

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

The version of Apache Kafka.

For more information, see Supported Apache Kafka versions in the Amazon MSK Developer Guide.

getNumberOfBrokerNodes

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

The number of broker nodes you want in the Amazon MSK cluster.

You can submit an update to increase the number of broker nodes in a cluster.

setNumberOfBrokerNodes

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

The number of broker nodes you want in the Amazon MSK cluster.

You can submit an update to increase the number of broker nodes in a cluster.

getClientAuthentication

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

Includes information related to client authentication.

setClientAuthentication

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

Includes information related to client authentication.

setClientAuthentication

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

Includes information related to client authentication.

getConfigurationInfo

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

The Amazon MSK configuration to use for the cluster.

setConfigurationInfo

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

The Amazon MSK configuration to use for the cluster.

setConfigurationInfo

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

The Amazon MSK configuration to use for the cluster.

getCurrentVersion

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

The version of the cluster that you want to update.

setCurrentVersion

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

The version of the cluster that you want to update.

getEncryptionInfo

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

Includes all encryption-related information.

setEncryptionInfo

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

Includes all encryption-related information.

setEncryptionInfo

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

Includes all encryption-related information.

getEnhancedMonitoring

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

Specifies the level of monitoring for the MSK cluster.

The possible values are DEFAULT , PER_BROKER , and PER_TOPIC_PER_BROKER .

setEnhancedMonitoring

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

Specifies the level of monitoring for the MSK cluster.

The possible values are DEFAULT , PER_BROKER , and PER_TOPIC_PER_BROKER .

getLoggingInfo

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

You can configure your Amazon MSK cluster to send broker logs to different destination types.

This is a container for the configuration details related to broker logs.

setLoggingInfo

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

You can configure your Amazon MSK cluster to send broker logs to different destination types.

This is a container for the configuration details related to broker logs.

setLoggingInfo

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

You can configure your Amazon MSK cluster to send broker logs to different destination types.

This is a container for the configuration details related to broker logs.

getOpenMonitoring

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

The settings for open monitoring.

setOpenMonitoring

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

The settings for open monitoring.

setOpenMonitoring

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

The settings for open monitoring.