software.amazon.awscdk.services.msk

Class Cluster.Builder

java.lang.Object

software.amazon.awscdk.services.msk.Cluster.Builder

Enclosing class:

Cluster

public static final class Cluster.Builder
extends java.lang.Object

(experimental) A fluent builder for Cluster.

Method Summary

Modifier and Type	Method and Description
Cluster	build()
Cluster.Builder	clientAuthentication(ClientAuthentication clientAuthentication) (experimental) Configuration properties for client authentication.
Cluster.Builder	clusterName(java.lang.String clusterName) (experimental) The physical name of the cluster.
Cluster.Builder	configurationInfo(ClusterConfigurationInfo configurationInfo) (experimental) The Amazon MSK configuration to use for the cluster.
static Cluster.Builder	create(software.constructs.Construct scope, java.lang.String id)
Cluster.Builder	ebsStorageInfo(EbsStorageInfo ebsStorageInfo) (experimental) Information about storage volumes attached to MSK broker nodes.
Cluster.Builder	encryptionInTransit(EncryptionInTransitConfig encryptionInTransit) (experimental) Config details for encryption in transit.
Cluster.Builder	instanceType(InstanceType instanceType) (experimental) The EC2 instance type that you want Amazon MSK to use when it creates your brokers.
Cluster.Builder	kafkaVersion(KafkaVersion kafkaVersion) (experimental) The version of Apache Kafka.
Cluster.Builder	logging(BrokerLogging logging) (experimental) Configure your MSK cluster to send broker logs to different destination types.
Cluster.Builder	monitoring(MonitoringConfiguration monitoring) (experimental) Cluster monitoring configuration.
Cluster.Builder	numberOfBrokerNodes(java.lang.Number numberOfBrokerNodes) (experimental) Number of Apache Kafka brokers deployed in each Availability Zone.
Cluster.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) What to do when this resource is deleted from a stack.
Cluster.Builder	securityGroups(java.util.List<? extends ISecurityGroup> securityGroups) (experimental) The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.
Cluster.Builder	vpc(IVpc vpc) (experimental) Defines the virtual networking environment for this cluster.
Cluster.Builder	vpcSubnets(SubnetSelection vpcSubnets) (experimental) Where to place the nodes within the VPC.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Cluster.Builder create(software.constructs.Construct scope,
                                     java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Cluster.Builder.

clusterName

public Cluster.Builder clusterName(java.lang.String clusterName)

(experimental) The physical name of the cluster.

Parameters:

clusterName - The physical name of the cluster. This parameter is required.

Returns:

this

kafkaVersion

public Cluster.Builder kafkaVersion(KafkaVersion kafkaVersion)

(experimental) The version of Apache Kafka.

Parameters:

kafkaVersion - The version of Apache Kafka. This parameter is required.

Returns:

this

vpc

public Cluster.Builder vpc(IVpc vpc)

(experimental) Defines the virtual networking environment for this cluster.

Must have at least 2 subnets in two different AZs.

Parameters:

vpc - Defines the virtual networking environment for this cluster. This parameter is required.

Returns:

this

clientAuthentication

public Cluster.Builder clientAuthentication(ClientAuthentication clientAuthentication)

(experimental) Configuration properties for client authentication.

MSK supports using private TLS certificates or SASL/SCRAM to authenticate the identity of clients.

Default: - disabled

Parameters:

clientAuthentication - Configuration properties for client authentication. This parameter is required.

Returns:

this

configurationInfo

public Cluster.Builder configurationInfo(ClusterConfigurationInfo configurationInfo)

(experimental) The Amazon MSK configuration to use for the cluster.

Default: - none

Parameters:

configurationInfo - The Amazon MSK configuration to use for the cluster. This parameter is required.

Returns:

this

ebsStorageInfo

public Cluster.Builder ebsStorageInfo(EbsStorageInfo ebsStorageInfo)

(experimental) Information about storage volumes attached to MSK broker nodes.

Default: - 1000 GiB EBS volume

Parameters:

ebsStorageInfo - Information about storage volumes attached to MSK broker nodes. This parameter is required.

Returns:

this

encryptionInTransit

public Cluster.Builder encryptionInTransit(EncryptionInTransitConfig encryptionInTransit)

(experimental) Config details for encryption in transit.

Default: - enabled

Parameters:

encryptionInTransit - Config details for encryption in transit. This parameter is required.

Returns:

this

instanceType

public Cluster.Builder instanceType(InstanceType instanceType)

(experimental) The EC2 instance type that you want Amazon MSK to use when it creates your brokers.

Default: kafka.m5.large

Parameters:

instanceType - The EC2 instance type that you want Amazon MSK to use when it creates your brokers. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/msk/latest/developerguide/msk-create-cluster.html#broker-instance-types

logging

public Cluster.Builder logging(BrokerLogging logging)

(experimental) Configure your MSK cluster to send broker logs to different destination types.

Default: - disabled

Parameters:

logging - Configure your MSK cluster to send broker logs to different destination types. This parameter is required.

Returns:

this

monitoring

public Cluster.Builder monitoring(MonitoringConfiguration monitoring)

(experimental) Cluster monitoring configuration.

Default: - DEFAULT monitoring level

Parameters:

monitoring - Cluster monitoring configuration. This parameter is required.

Returns:

this

numberOfBrokerNodes

public Cluster.Builder numberOfBrokerNodes(java.lang.Number numberOfBrokerNodes)

(experimental) Number of Apache Kafka brokers deployed in each Availability Zone.

Default: 1

Parameters:

numberOfBrokerNodes - Number of Apache Kafka brokers deployed in each Availability Zone. This parameter is required.

Returns:

this

removalPolicy

public Cluster.Builder removalPolicy(RemovalPolicy removalPolicy)

(experimental) What to do when this resource is deleted from a stack.

Default: RemovalPolicy.RETAIN

Parameters:

removalPolicy - What to do when this resource is deleted from a stack. This parameter is required.

Returns:

this

securityGroups

public Cluster.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)

(experimental) The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.

Default: - create new security group

Parameters:

securityGroups - The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. This parameter is required.

Returns:

this

vpcSubnets

public Cluster.Builder vpcSubnets(SubnetSelection vpcSubnets)

(experimental) Where to place the nodes within the VPC.

Amazon MSK distributes the broker nodes evenly across the subnets that you specify. The subnets that you specify must be in distinct Availability Zones. Client subnets can't be in Availability Zone us-east-1e.

Default: - the Vpc default strategy if not specified.

Parameters:

vpcSubnets - Where to place the nodes within the VPC. This parameter is required.

Returns:

this

build

public Cluster build()