software.amazon.awscdk.services.msk

Class Cluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.msk.Cluster

All Implemented Interfaces:

IDependable, IResource, IConnectable, ICluster, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:12.508Z")
 @Stability(value=Experimental)
public class Cluster
extends Resource
implements ICluster

(experimental) Create a MSK Cluster.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 Cluster cluster = Cluster.Builder.create(this, "Cluster")....build();
 cluster.connections.allowFrom(Peer.ipv4("1.2.3.4/8"), Port.tcp(2181));
 cluster.connections.allowFrom(Peer.ipv4("1.2.3.4/8"), Port.tcp(9094));
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	Cluster(software.constructs.Construct scope, String id, ClusterProps props)
protected	Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Cluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addUser(String... usernames) (experimental) A list of usersnames to register with the cluster.
static ICluster	fromClusterArn(software.constructs.Construct scope, String id, String clusterArn) (experimental) Reference an existing cluster, defined outside of the CDK code, by name.
String	getBootstrapBrokers() (experimental) Get the list of brokers that a client application can use to bootstrap.
String	getBootstrapBrokersSaslScram() (experimental) Get the list of brokers that a SASL/SCRAM authenticated client application can use to bootstrap.
String	getBootstrapBrokersTls() (experimental) Get the list of brokers that a TLS authenticated client application can use to bootstrap.
String	getClusterArn() (experimental) The ARN of cluster.
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.
String	getZookeeperConnectionString() (experimental) Get the ZooKeeper Connection string.
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 software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Cluster

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

Cluster

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

Cluster

@Stability(value=Experimental)
public Cluster(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              ClusterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromClusterArn

@Stability(value=Experimental)
 @NotNull
public static ICluster fromClusterArn(@NotNull
                                                                               software.constructs.Construct scope,
                                                                               @NotNull
                                                                               String id,
                                                                               @NotNull
                                                                               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

@Stability(value=Experimental)
public void addUser(@NotNull
                                                   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

@Stability(value=Experimental)
 @NotNull
public 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

@Stability(value=Experimental)
 @NotNull
public 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

@Stability(value=Experimental)
 @NotNull
public 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

@Stability(value=Experimental)
 @NotNull
public String getClusterArn()

(experimental) The ARN of cluster.

Specified by:

getClusterArn in interface ICluster

getClusterName

@Stability(value=Experimental)
 @NotNull
public String getClusterName()

(experimental) The physical name of the cluster.

Specified by:

getClusterName in interface ICluster

getConnections

@Stability(value=Experimental)
 @NotNull
public Connections getConnections()

(experimental) Manages connections for the cluster.

Specified by:

getConnections in interface IConnectable

getZookeeperConnectionString

@Stability(value=Experimental)
 @NotNull
public 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

@Stability(value=Experimental)
 @NotNull
public 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

@Stability(value=Experimental)
 @Nullable
public IKey getSaslScramAuthenticationKey()

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