CfnCluster

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.msk.CfnCluster

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.710Z")
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())
                         .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();

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 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` Not currently supported by AWS CloudFormation .
`static interface`	`CfnCluster.VpcConnectivityIamProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnCluster.VpcConnectivityProperty` Example:
`static interface`	`CfnCluster.VpcConnectivitySaslProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnCluster.VpcConnectivityScramProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnCluster.VpcConnectivityTlsProperty` Not currently supported by AWS CloudFormation .

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnCluster(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()`
`java.lang.Object`	`getBrokerNodeGroupInfo()` The setup to be used for brokers in the cluster.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getClientAuthentication()` Includes information related to client authentication.
`java.lang.String`	`getClusterName()` The name of the cluster.
`java.lang.Object`	`getConfigurationInfo()` The Amazon MSK configuration to use for the cluster.
`java.lang.String`	`getCurrentVersion()` The version of the cluster that you want to update.
`java.lang.Object`	`getEncryptionInfo()` Includes all encryption-related information.
`java.lang.String`	`getEnhancedMonitoring()` Specifies the level of monitoring for the MSK cluster.
`java.lang.String`	`getKafkaVersion()` The version of Apache Kafka.
`java.lang.Object`	`getLoggingInfo()` You can configure your Amazon MSK cluster to send broker logs to different destination types.
`java.lang.Number`	`getNumberOfBrokerNodes()` The number of broker nodes you want in the Amazon MSK cluster.
`java.lang.Object`	`getOpenMonitoring()` The settings for open monitoring.
`java.lang.String`	`getStorageMode()` This controls storage mode for supported storage tiers.
`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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.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(java.lang.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(java.lang.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(java.lang.String value)` Specifies the level of monitoring for the MSK cluster.
`void`	`setKafkaVersion(java.lang.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(java.lang.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.
`void`	`setStorageMode(java.lang.String value)` This controls storage mode for supported storage tiers.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnCluster(Construct scope,
                  java.lang.String id,
                  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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    A map of key:value pairs to apply to this resource.
    Both key and value are of type String.
  - getBrokerNodeGroupInfo
```
public java.lang.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
```
public void setBrokerNodeGroupInfo(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
```
public void setBrokerNodeGroupInfo(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
```
public java.lang.String getClusterName()
```
    The name of the cluster.
  - setClusterName
```
public void setClusterName(java.lang.String value)
```
    The name of the cluster.
  - getKafkaVersion
```
public java.lang.String getKafkaVersion()
```
    The version of Apache Kafka.
    For more information, see Supported Apache Kafka versions in the Amazon MSK Developer Guide.
  - setKafkaVersion
```
public void setKafkaVersion(java.lang.String value)
```
    The version of Apache Kafka.
    For more information, see Supported Apache Kafka versions in the Amazon MSK Developer Guide.
  - getNumberOfBrokerNodes
```
public java.lang.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
```
public void setNumberOfBrokerNodes(java.lang.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
```
public java.lang.Object getClientAuthentication()
```
    Includes information related to client authentication.
  - setClientAuthentication
```
public void setClientAuthentication(IResolvable value)
```
    Includes information related to client authentication.
  - setClientAuthentication
```
public void setClientAuthentication(CfnCluster.ClientAuthenticationProperty value)
```
    Includes information related to client authentication.
  - getConfigurationInfo
```
public java.lang.Object getConfigurationInfo()
```
    The Amazon MSK configuration to use for the cluster.
  - setConfigurationInfo
```
public void setConfigurationInfo(IResolvable value)
```
    The Amazon MSK configuration to use for the cluster.
  - setConfigurationInfo
```
public void setConfigurationInfo(CfnCluster.ConfigurationInfoProperty value)
```
    The Amazon MSK configuration to use for the cluster.
  - getCurrentVersion
```
public java.lang.String getCurrentVersion()
```
    The version of the cluster that you want to update.
  - setCurrentVersion
```
public void setCurrentVersion(java.lang.String value)
```
    The version of the cluster that you want to update.
  - getEncryptionInfo
```
public java.lang.Object getEncryptionInfo()
```
    Includes all encryption-related information.
  - setEncryptionInfo
```
public void setEncryptionInfo(IResolvable value)
```
    Includes all encryption-related information.
  - setEncryptionInfo
```
public void setEncryptionInfo(CfnCluster.EncryptionInfoProperty value)
```
    Includes all encryption-related information.
  - getEnhancedMonitoring
```
public java.lang.String getEnhancedMonitoring()
```
    Specifies the level of monitoring for the MSK cluster.
    The possible values are DEFAULT , PER_BROKER , and PER_TOPIC_PER_BROKER .
  - setEnhancedMonitoring
```
public void setEnhancedMonitoring(java.lang.String value)
```
    Specifies the level of monitoring for the MSK cluster.
    The possible values are DEFAULT , PER_BROKER , and PER_TOPIC_PER_BROKER .
  - getLoggingInfo
```
public java.lang.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
```
public void setLoggingInfo(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.
  - setLoggingInfo
```
public void setLoggingInfo(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.
  - getOpenMonitoring
```
public java.lang.Object getOpenMonitoring()
```
    The settings for open monitoring.
  - setOpenMonitoring
```
public void setOpenMonitoring(IResolvable value)
```
    The settings for open monitoring.
  - setOpenMonitoring
```
public void setOpenMonitoring(CfnCluster.OpenMonitoringProperty value)
```
    The settings for open monitoring.
  - getStorageMode
```
public java.lang.String getStorageMode()
```
    This controls storage mode for supported storage tiers.
  - setStorageMode
```
public void setStorageMode(java.lang.String value)
```
    This controls storage mode for supported storage tiers.

Class CfnCluster

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnCluster

CfnCluster

CfnCluster

Method Detail

inspect

renderProperties

getAttrArn

getCfnProperties

getTags

getBrokerNodeGroupInfo

setBrokerNodeGroupInfo

setBrokerNodeGroupInfo

getClusterName

setClusterName

getKafkaVersion

setKafkaVersion

getNumberOfBrokerNodes

setNumberOfBrokerNodes

getClientAuthentication

setClientAuthentication

setClientAuthentication

getConfigurationInfo

setConfigurationInfo

setConfigurationInfo

getCurrentVersion

setCurrentVersion

getEncryptionInfo

setEncryptionInfo

setEncryptionInfo

getEnhancedMonitoring

setEnhancedMonitoring

getLoggingInfo

setLoggingInfo

setLoggingInfo

getOpenMonitoring

setOpenMonitoring

setOpenMonitoring

getStorageMode

setStorageMode