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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.596Z")
 @Stability(value=Stable)
public class CfnCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::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.*;
 Object tags;
 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()
                                 .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())
         .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(tags)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnCluster.BrokerLogsProperty Example:
static interface	CfnCluster.BrokerNodeGroupInfoProperty Example:
static 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.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:

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
Object	getBrokerNodeGroupInfo() `AWS::MSK::Cluster.BrokerNodeGroupInfo`.
protected Map<String,Object>	getCfnProperties()
Object	getClientAuthentication() `AWS::MSK::Cluster.ClientAuthentication`.
String	getClusterName() `AWS::MSK::Cluster.ClusterName`.
Object	getConfigurationInfo() `AWS::MSK::Cluster.ConfigurationInfo`.
Object	getEncryptionInfo() `AWS::MSK::Cluster.EncryptionInfo`.
String	getEnhancedMonitoring() `AWS::MSK::Cluster.EnhancedMonitoring`.
String	getKafkaVersion() `AWS::MSK::Cluster.KafkaVersion`.
Object	getLoggingInfo() `AWS::MSK::Cluster.LoggingInfo`.
Number	getNumberOfBrokerNodes() `AWS::MSK::Cluster.NumberOfBrokerNodes`.
Object	getOpenMonitoring() `AWS::MSK::Cluster.OpenMonitoring`.
TagManager	getTags() `AWS::MSK::Cluster.Tags`.
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) `AWS::MSK::Cluster.BrokerNodeGroupInfo`.
void	setBrokerNodeGroupInfo(IResolvable value) `AWS::MSK::Cluster.BrokerNodeGroupInfo`.
void	setClientAuthentication(CfnCluster.ClientAuthenticationProperty value) `AWS::MSK::Cluster.ClientAuthentication`.
void	setClientAuthentication(IResolvable value) `AWS::MSK::Cluster.ClientAuthentication`.
void	setClusterName(String value) `AWS::MSK::Cluster.ClusterName`.
void	setConfigurationInfo(CfnCluster.ConfigurationInfoProperty value) `AWS::MSK::Cluster.ConfigurationInfo`.
void	setConfigurationInfo(IResolvable value) `AWS::MSK::Cluster.ConfigurationInfo`.
void	setEncryptionInfo(CfnCluster.EncryptionInfoProperty value) `AWS::MSK::Cluster.EncryptionInfo`.
void	setEncryptionInfo(IResolvable value) `AWS::MSK::Cluster.EncryptionInfo`.
void	setEnhancedMonitoring(String value) `AWS::MSK::Cluster.EnhancedMonitoring`.
void	setKafkaVersion(String value) `AWS::MSK::Cluster.KafkaVersion`.
void	setLoggingInfo(CfnCluster.LoggingInfoProperty value) `AWS::MSK::Cluster.LoggingInfo`.
void	setLoggingInfo(IResolvable value) `AWS::MSK::Cluster.LoggingInfo`.
void	setNumberOfBrokerNodes(Number value) `AWS::MSK::Cluster.NumberOfBrokerNodes`.
void	setOpenMonitoring(CfnCluster.OpenMonitoringProperty value) `AWS::MSK::Cluster.OpenMonitoring`.
void	setOpenMonitoring(IResolvable value) `AWS::MSK::Cluster.OpenMonitoring`.

Methods inherited from class software.amazon.awscdk.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.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.

getBrokerNodeGroupInfo

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

`AWS::MSK::Cluster.BrokerNodeGroupInfo`.

setBrokerNodeGroupInfo

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

`AWS::MSK::Cluster.BrokerNodeGroupInfo`.

setBrokerNodeGroupInfo

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

`AWS::MSK::Cluster.BrokerNodeGroupInfo`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getClientAuthentication

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

`AWS::MSK::Cluster.ClientAuthentication`.

setClientAuthentication

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

`AWS::MSK::Cluster.ClientAuthentication`.

setClientAuthentication

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

`AWS::MSK::Cluster.ClientAuthentication`.

getClusterName

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

`AWS::MSK::Cluster.ClusterName`.

setClusterName

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

`AWS::MSK::Cluster.ClusterName`.

getConfigurationInfo

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

`AWS::MSK::Cluster.ConfigurationInfo`.

setConfigurationInfo

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

`AWS::MSK::Cluster.ConfigurationInfo`.

setConfigurationInfo

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

`AWS::MSK::Cluster.ConfigurationInfo`.

getEncryptionInfo

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

`AWS::MSK::Cluster.EncryptionInfo`.

setEncryptionInfo

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

`AWS::MSK::Cluster.EncryptionInfo`.

setEncryptionInfo

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

`AWS::MSK::Cluster.EncryptionInfo`.

getEnhancedMonitoring

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

`AWS::MSK::Cluster.EnhancedMonitoring`.

setEnhancedMonitoring

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

`AWS::MSK::Cluster.EnhancedMonitoring`.

getKafkaVersion

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

`AWS::MSK::Cluster.KafkaVersion`.

setKafkaVersion

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

`AWS::MSK::Cluster.KafkaVersion`.

getLoggingInfo

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

`AWS::MSK::Cluster.LoggingInfo`.

setLoggingInfo

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

`AWS::MSK::Cluster.LoggingInfo`.

setLoggingInfo

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

`AWS::MSK::Cluster.LoggingInfo`.

getNumberOfBrokerNodes

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

`AWS::MSK::Cluster.NumberOfBrokerNodes`.

setNumberOfBrokerNodes

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

`AWS::MSK::Cluster.NumberOfBrokerNodes`.

getOpenMonitoring

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

`AWS::MSK::Cluster.OpenMonitoring`.

setOpenMonitoring

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

`AWS::MSK::Cluster.OpenMonitoring`.

setOpenMonitoring

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

`AWS::MSK::Cluster.OpenMonitoring`.

getTags

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

`AWS::MSK::Cluster.Tags`.