Package software.amazon.awscdk.services.msk.alpha

Class ClusterProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ClusterProps>

Enclosing interface:

ClusterProps

@Stability(Experimental)
public static final class ClusterProps.Builder
extends Object
implements software.amazon.jsii.Builder<ClusterProps>

A builder for ClusterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterProps	build()	Builds the configured instance.
ClusterProps.Builder	clientAuthentication(ClientAuthentication clientAuthentication)	Sets the value of ClusterProps.getClientAuthentication()
ClusterProps.Builder	clusterName(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(Number numberOfBrokerNodes)	Sets the value of ClusterProps.getNumberOfBrokerNodes()
ClusterProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of ClusterProps.getRemovalPolicy()
ClusterProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ClusterProps.getSecurityGroups()
ClusterProps.Builder	storageMode(StorageMode storageMode)	Sets the value of ClusterProps.getStorageMode()
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 Details

Builder

public Builder()

Method Details

clusterName

@Stability(Experimental)
public ClusterProps.Builder clusterName(String clusterName)

Sets the value of ClusterProps.getClusterName()

Parameters:

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

Returns:

this

kafkaVersion

@Stability(Experimental)
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

@Stability(Experimental)
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

@Stability(Experimental)
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

@Stability(Experimental)
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

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps.Builder encryptionInTransit(EncryptionInTransitConfig encryptionInTransit)

Sets the value of ClusterProps.getEncryptionInTransit()

Parameters:

encryptionInTransit - Config details for encryption in transit.

Returns:

this

instanceType

@Stability(Experimental)
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

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps.Builder monitoring(MonitoringConfiguration monitoring)

Sets the value of ClusterProps.getMonitoring()

Parameters:

monitoring - Cluster monitoring configuration.

Returns:

this

numberOfBrokerNodes

@Stability(Experimental)
public ClusterProps.Builder numberOfBrokerNodes(Number numberOfBrokerNodes)

Sets the value of ClusterProps.getNumberOfBrokerNodes()

Parameters:

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

Returns:

this

removalPolicy

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps.Builder securityGroups(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

storageMode

@Stability(Experimental)
public ClusterProps.Builder storageMode(StorageMode storageMode)

Sets the value of ClusterProps.getStorageMode()

Parameters:

storageMode - This controls storage mode for supported storage tiers.

Returns:

this

vpcSubnets

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ClusterProps>

Returns:

a new instance of ClusterProps

Throws:

NullPointerException - if any required attribute was not provided