software.amazon.awscdk.services.msk

Class Cluster

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.msk.Cluster

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, ICluster

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:40.324Z")
public class Cluster
extends Resource
implements ICluster

(experimental) Create a MSK Cluster.

Example:

 Vpc vpc;
 Cluster cluster = Cluster.Builder.create(this, "cluster")
         .clusterName("myCluster")
         .kafkaVersion(KafkaVersion.V2_8_1)
         .vpc(vpc)
         .encryptionInTransit(EncryptionInTransitConfig.builder()
                 .clientBroker(ClientBrokerEncryption.TLS)
                 .build())
         .clientAuthentication(ClientAuthentication.sasl(SaslAuthProps.builder()
                 .scram(true)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.Builder (experimental) A fluent builder for Cluster.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.msk.ICluster

ICluster.Jsii$Default, ICluster.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Cluster(software.amazon.jsii.JsiiObjectRef objRef)
	Cluster(software.constructs.Construct scope, java.lang.String id, ClusterProps props)

Method Summary

Modifier and Type	Method and Description
void	addUser(java.lang.String... usernames) (experimental) A list of usersnames to register with the cluster.
static ICluster	fromClusterArn(software.constructs.Construct scope, java.lang.String id, java.lang.String clusterArn) (experimental) Reference an existing cluster, defined outside of the CDK code, by name.
java.lang.String	getBootstrapBrokers() (experimental) Get the list of brokers that a client application can use to bootstrap.
java.lang.String	getBootstrapBrokersSaslScram() (experimental) Get the list of brokers that a SASL/SCRAM authenticated client application can use to bootstrap.
java.lang.String	getBootstrapBrokersTls() (experimental) Get the list of brokers that a TLS authenticated client application can use to bootstrap.
java.lang.String	getClusterArn() (experimental) The ARN of cluster.
java.lang.String	getClusterName() (experimental) The physical name of the cluster.
Connections	getConnections() (experimental) Manages connections for the cluster.
IKey	getSaslScramAuthenticationKey() (experimental) Key used to encrypt SASL/SCRAM users.
java.lang.String	getZookeeperConnectionString() (experimental) Get the ZooKeeper Connection string.
java.lang.String	getZookeeperConnectionStringTls() (experimental) Get the ZooKeeper Connection string for a TLS enabled cluster.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Cluster

protected Cluster(software.amazon.jsii.JsiiObjectRef objRef)

Cluster

protected Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Cluster

public Cluster(software.constructs.Construct scope,
               java.lang.String id,
               ClusterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromClusterArn

public static ICluster fromClusterArn(software.constructs.Construct scope,
                                      java.lang.String id,
                                      java.lang.String clusterArn)

(experimental) Reference an existing cluster, defined outside of the CDK code, by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

clusterArn - This parameter is required.

addUser

public void addUser(java.lang.String... usernames)

(experimental) A list of usersnames to register with the cluster.

The password will automatically be generated using Secrets Manager and the { username, password } JSON object stored in Secrets Manager as AmazonMSK_username.

Must be using the SASL/SCRAM authentication mechanism.

Parameters:

usernames - - username(s) to register with the cluster. This parameter is required.

getBootstrapBrokers

public java.lang.String getBootstrapBrokers()

(experimental) Get the list of brokers that a client application can use to bootstrap.

Uses a Custom Resource to make an API call to getBootstrapBrokers using the Javascript SDK

Returns:

- A string containing one or more hostname:port pairs.

getBootstrapBrokersSaslScram

public java.lang.String getBootstrapBrokersSaslScram()

(experimental) Get the list of brokers that a SASL/SCRAM authenticated client application can use to bootstrap.

Uses a Custom Resource to make an API call to getBootstrapBrokers using the Javascript SDK

Returns:

- A string containing one or more dns name (or IP) and SASL SCRAM port pairs.

getBootstrapBrokersTls

public java.lang.String getBootstrapBrokersTls()

(experimental) Get the list of brokers that a TLS authenticated client application can use to bootstrap.

Uses a Custom Resource to make an API call to getBootstrapBrokers using the Javascript SDK

Returns:

- A string containing one or more DNS names (or IP) and TLS port pairs.

getClusterArn

public java.lang.String getClusterArn()

(experimental) The ARN of cluster.

Specified by:

getClusterArn in interface ICluster

getClusterName

public java.lang.String getClusterName()

(experimental) The physical name of the cluster.

Specified by:

getClusterName in interface ICluster

getConnections

public Connections getConnections()

(experimental) Manages connections for the cluster.

Specified by:

getConnections in interface IConnectable

getZookeeperConnectionString

public java.lang.String getZookeeperConnectionString()

(experimental) Get the ZooKeeper Connection string.

Uses a Custom Resource to make an API call to describeCluster using the Javascript SDK

Returns:

- The connection string to use to connect to the Apache ZooKeeper cluster.

getZookeeperConnectionStringTls

public java.lang.String getZookeeperConnectionStringTls()

(experimental) Get the ZooKeeper Connection string for a TLS enabled cluster.

Uses a Custom Resource to make an API call to describeCluster using the Javascript SDK

Returns:

- The connection string to use to connect to zookeeper cluster on TLS port.

getSaslScramAuthenticationKey

public IKey getSaslScramAuthenticationKey()

(experimental) Key used to encrypt SASL/SCRAM users.