software.amazon.awscdk.services.msk

Interface CfnClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.987Z")
 @Stability(value=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())
                         .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	Interface and Description
static class	CfnClusterProps.Builder A builder for CfnClusterProps
static class	CfnClusterProps.Jsii$Proxy An implementation for CfnClusterProps

Method Summary

Modifier and Type	Method and Description
static CfnClusterProps.Builder	builder()
Object	getBrokerNodeGroupInfo() The setup to be used for brokers in the cluster.
default Object	getClientAuthentication() Includes information related to client authentication.
String	getClusterName() The name of the cluster.
default Object	getConfigurationInfo() The Amazon MSK configuration to use for the cluster.
default String	getCurrentVersion() The version of the cluster that you want to update.
default Object	getEncryptionInfo() Includes all encryption-related information.
default String	getEnhancedMonitoring() Specifies the level of monitoring for the MSK cluster.
String	getKafkaVersion() The version of Apache Kafka.
default 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.
default Object	getOpenMonitoring() The settings for open monitoring.
default Map<String,String>	getTags() A map of key:value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBrokerNodeGroupInfo

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

getClusterName

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

The name of the cluster.

getKafkaVersion

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

The version of Apache Kafka.

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

getNumberOfBrokerNodes

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

getClientAuthentication

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

Includes information related to client authentication.

getConfigurationInfo

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

The Amazon MSK configuration to use for the cluster.

getCurrentVersion

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

The version of the cluster that you want to update.

getEncryptionInfo

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

Includes all encryption-related information.

getEnhancedMonitoring

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

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
default 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.

getOpenMonitoring

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

The settings for open monitoring.

getTags

@Stability(value=Stable)
 @Nullable
default Map<String,String> getTags()

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

Both key and value are of type String.

builder

@Stability(value=Stable)
static CfnClusterProps.Builder builder()

Returns:

a CfnClusterProps.Builder of CfnClusterProps