software.amazon.awscdk.services.msk

Class ClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.msk.ClusterProps.Builder

Enclosing interface:

ClusterProps

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

A builder for ClusterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ClusterProps	build() Builds the configured instance.
ClusterProps.Builder	clientAuthentication(ClientAuthentication clientAuthentication) Sets the value of ClusterProps.getClientAuthentication()
ClusterProps.Builder	clusterName(java.lang.String clusterName) Sets the value of ClusterProps.getClusterName()
ClusterProps.Builder	configurationInfo(ClusterConfigurationInfo configurationInfo) Sets the value of ClusterProps.getConfigurationInfo()
ClusterProps.Builder	ebsStorageInfo(EbsStorageInfo ebsStorageInfo) Sets the value of ClusterProps.getEbsStorageInfo()
ClusterProps.Builder	encryptionInTransit(EncryptionInTransitConfig encryptionInTransit) Sets the value of ClusterProps.getEncryptionInTransit()
ClusterProps.Builder	instanceType(InstanceType instanceType) Sets the value of ClusterProps.getInstanceType()
ClusterProps.Builder	kafkaVersion(KafkaVersion kafkaVersion) Sets the value of ClusterProps.getKafkaVersion()
ClusterProps.Builder	logging(BrokerLogging logging) Sets the value of ClusterProps.getLogging()
ClusterProps.Builder	monitoring(MonitoringConfiguration monitoring) Sets the value of ClusterProps.getMonitoring()
ClusterProps.Builder	numberOfBrokerNodes(java.lang.Number numberOfBrokerNodes) Sets the value of ClusterProps.getNumberOfBrokerNodes()
ClusterProps.Builder	removalPolicy(RemovalPolicy removalPolicy) Sets the value of ClusterProps.getRemovalPolicy()
ClusterProps.Builder	securityGroups(java.util.List<? extends ISecurityGroup> securityGroups) Sets the value of ClusterProps.getSecurityGroups()
ClusterProps.Builder	vpc(IVpc vpc) Sets the value of ClusterProps.getVpc()
ClusterProps.Builder	vpcSubnets(SubnetSelection vpcSubnets) Sets the value of ClusterProps.getVpcSubnets()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

clusterName

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

Sets the value of ClusterProps.getClusterName()

Parameters:

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

Returns:

this

kafkaVersion

public ClusterProps.Builder kafkaVersion(KafkaVersion kafkaVersion)

Sets the value of ClusterProps.getKafkaVersion()

Parameters:

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

Returns:

this

vpc

public ClusterProps.Builder vpc(IVpc vpc)

Sets the value of ClusterProps.getVpc()

Parameters:

vpc - Defines the virtual networking environment for this cluster. This parameter is required. Must have at least 2 subnets in two different AZs.

Returns:

this

clientAuthentication

public ClusterProps.Builder clientAuthentication(ClientAuthentication clientAuthentication)

Sets the value of ClusterProps.getClientAuthentication()

Parameters:

clientAuthentication - Configuration properties for client authentication. MSK supports using private TLS certificates or SASL/SCRAM to authenticate the identity of clients.

Returns:

this

configurationInfo

public ClusterProps.Builder configurationInfo(ClusterConfigurationInfo configurationInfo)

Sets the value of ClusterProps.getConfigurationInfo()

Parameters:

configurationInfo - The Amazon MSK configuration to use for the cluster.

Returns:

this

ebsStorageInfo

public ClusterProps.Builder ebsStorageInfo(EbsStorageInfo ebsStorageInfo)

Sets the value of ClusterProps.getEbsStorageInfo()

Parameters:

ebsStorageInfo - Information about storage volumes attached to MSK broker nodes.

Returns:

this

encryptionInTransit

public ClusterProps.Builder encryptionInTransit(EncryptionInTransitConfig encryptionInTransit)

Sets the value of ClusterProps.getEncryptionInTransit()

Parameters:

encryptionInTransit - Config details for encryption in transit.

Returns:

this

instanceType

public ClusterProps.Builder instanceType(InstanceType instanceType)

Sets the value of ClusterProps.getInstanceType()

Parameters:

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

Returns:

this

logging

public ClusterProps.Builder logging(BrokerLogging logging)

Sets the value of ClusterProps.getLogging()

Parameters:

logging - Configure your MSK cluster to send broker logs to different destination types.

Returns:

this

monitoring

public ClusterProps.Builder monitoring(MonitoringConfiguration monitoring)

Sets the value of ClusterProps.getMonitoring()

Parameters:

monitoring - Cluster monitoring configuration.

Returns:

this

numberOfBrokerNodes

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

Sets the value of ClusterProps.getNumberOfBrokerNodes()

Parameters:

numberOfBrokerNodes - Number of Apache Kafka brokers deployed in each Availability Zone.

Returns:

this

removalPolicy

public ClusterProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of ClusterProps.getRemovalPolicy()

Parameters:

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

Returns:

this

securityGroups

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

Sets the value of ClusterProps.getSecurityGroups()

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.

Returns:

this

vpcSubnets

public ClusterProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of ClusterProps.getVpcSubnets()

Parameters:

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

Returns:

this

build

public ClusterProps build()

Builds the configured instance.

Returns:

a new instance of ClusterProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided