Class Cluster

(experimental) Create a MSK Cluster.

Inheritance

System.Object

Resource

ClusterBase

Cluster

Implements

ICluster

IResource

Constructs.IConstruct

Constructs.IDependable

IConnectable

Inherited Members

ClusterBase.Connections

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.MSK.Alpha

Assembly: Amazon.CDK.AWS.MSK.Alpha.dll

Syntax (csharp)

public class Cluster : ClusterBase, ICluster, IResource, IConnectable

Syntax (vb)

Public Class Cluster
    Inherits ClusterBase
    Implements ICluster, IResource, IConnectable

Remarks

Stability: Experimental

Resource: AWS::MSK::Cluster

ExampleMetadata: infused

Examples

Vpc vpc;

var cluster = new Cluster(this, "cluster", new ClusterProps {
    ClusterName = "myCluster",
    KafkaVersion = KafkaVersion.V3_8_X,
    Vpc = vpc,
    EncryptionInTransit = new EncryptionInTransitConfig {
        ClientBroker = ClientBrokerEncryption.TLS
    },
    ClientAuthentication = ClientAuthentication.Sasl(new SaslAuthProps {
        Scram = true
    })
});

Synopsis

Constructors

Cluster(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Cluster(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
Cluster(Construct, String, IClusterProps)

Properties

BootstrapBrokers	(experimental) Get the list of brokers that a client application can use to bootstrap.
BootstrapBrokersSaslIam	(experimental) Get the list of brokers that a SASL/IAM authenticated client application can use to bootstrap.
BootstrapBrokersSaslScram	(experimental) Get the list of brokers that a SASL/SCRAM authenticated client application can use to bootstrap.
BootstrapBrokersTls	(experimental) Get the list of brokers that a TLS authenticated client application can use to bootstrap.
ClusterArn	(experimental) The ARN of cluster.
ClusterName	(experimental) The physical name of the cluster.
SaslScramAuthenticationKey	(experimental) Key used to encrypt SASL/SCRAM users.
ZookeeperConnectionString	(experimental) Get the ZooKeeper Connection string.
ZookeeperConnectionStringTls	(experimental) Get the ZooKeeper Connection string for a TLS enabled cluster.

Methods

AddUser(String[])	(experimental) A list of usersnames to register with the cluster.
FromClusterArn(Construct, String, String)	(experimental) Reference an existing cluster, defined outside of the CDK code, by name.

Constructors

Cluster(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Cluster(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

Cluster(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Cluster(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Cluster(Construct, String, IClusterProps)

public Cluster(Construct scope, string id, IClusterProps props)

Parameters

scope Constructs.Construct
id System.String
props IClusterProps

Remarks

Stability: Experimental

Properties

BootstrapBrokers

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

public virtual string BootstrapBrokers { get; }

Property Value

System.String

A string containing one or more hostname:port pairs.

Remarks

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

Stability: Experimental

BootstrapBrokersSaslIam

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

public virtual string BootstrapBrokersSaslIam { get; }

Property Value

System.String

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

Remarks

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

Stability: Experimental

BootstrapBrokersSaslScram

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

public virtual string BootstrapBrokersSaslScram { get; }

Property Value

System.String

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

Remarks

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

Stability: Experimental

BootstrapBrokersTls

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

public virtual string BootstrapBrokersTls { get; }

Property Value

System.String

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

Remarks

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

Stability: Experimental

ClusterArn

(experimental) The ARN of cluster.

public override string ClusterArn { get; }

Property Value

System.String

Overrides

ClusterBase.ClusterArn

Remarks

Stability: Experimental

ClusterName

(experimental) The physical name of the cluster.

public override string ClusterName { get; }

Property Value

System.String

Overrides

ClusterBase.ClusterName

Remarks

Stability: Experimental

SaslScramAuthenticationKey

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

public virtual IKey SaslScramAuthenticationKey { get; }

Property Value

IKey

Remarks

Stability: Experimental

ZookeeperConnectionString

(experimental) Get the ZooKeeper Connection string.

public virtual string ZookeeperConnectionString { get; }

Property Value

System.String

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

Remarks

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

Stability: Experimental

ZookeeperConnectionStringTls

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

public virtual string ZookeeperConnectionStringTls { get; }

Property Value

System.String

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

Remarks

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

Stability: Experimental

Methods

AddUser(String[])

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

public virtual void AddUser(params string[] usernames)

Parameters

usernames System.String[]

username(s) to register with the cluster.

Remarks

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.

Stability: Experimental

FromClusterArn(Construct, String, String)

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

public static ICluster FromClusterArn(Construct scope, string id, string clusterArn)

Parameters

scope Constructs.Construct
id System.String
clusterArn System.String

Returns

ICluster

Remarks

Stability: Experimental

Implements

ICluster

IResource

Constructs.IConstruct

Constructs.IDependable

IConnectable