Class ClusterProps

(experimental) Properties for a MSK Cluster.

Inheritance
System.Object
ClusterProps
Implements
Namespace: Amazon.CDK.AWS.MSK
Assembly: Amazon.CDK.AWS.MSK.dll
Syntax (csharp)
public class ClusterProps : Object, IClusterProps
Syntax (vb)
Public Class ClusterProps
    Inherits Object
    Implements IClusterProps
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
Vpc vpc;

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

Synopsis

Constructors

ClusterProps()

Properties

ClientAuthentication

(experimental) Configuration properties for client authentication.
ClusterName

(experimental) The physical name of the cluster.
ConfigurationInfo

(experimental) The Amazon MSK configuration to use for the cluster.
EbsStorageInfo

(experimental) Information about storage volumes attached to MSK broker nodes.
EncryptionInTransit

(experimental) Config details for encryption in transit.
InstanceType

(experimental) The EC2 instance type that you want Amazon MSK to use when it creates your brokers.
KafkaVersion

(experimental) The version of Apache Kafka.
Logging

(experimental) Configure your MSK cluster to send broker logs to different destination types.
Monitoring

(experimental) Cluster monitoring configuration.
NumberOfBrokerNodes

(experimental) Number of Apache Kafka brokers deployed in each Availability Zone.
RemovalPolicy

(experimental) What to do when this resource is deleted from a stack.
SecurityGroups

(experimental) 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.
Vpc

(experimental) Defines the virtual networking environment for this cluster.
VpcSubnets

(experimental) Where to place the nodes within the VPC.

Constructors

ClusterProps()

public ClusterProps()

Properties

ClientAuthentication

(experimental) Configuration properties for client authentication.

public ClientAuthentication ClientAuthentication { get; set; }
Property Value

ClientAuthentication

Remarks

MSK supports using private TLS certificates or SASL/SCRAM to authenticate the identity of clients.

Default: - disabled

Stability: Experimental

ClusterName

(experimental) The physical name of the cluster.

public string ClusterName { get; set; }
Property Value

System.String

Remarks

Stability: Experimental

ConfigurationInfo

(experimental) The Amazon MSK configuration to use for the cluster.

public IClusterConfigurationInfo ConfigurationInfo { get; set; }
Property Value

IClusterConfigurationInfo

Remarks

Default: - none

Stability: Experimental

EbsStorageInfo

(experimental) Information about storage volumes attached to MSK broker nodes.

public IEbsStorageInfo EbsStorageInfo { get; set; }
Property Value

IEbsStorageInfo

Remarks

Default: - 1000 GiB EBS volume

Stability: Experimental

EncryptionInTransit

(experimental) Config details for encryption in transit.

public IEncryptionInTransitConfig EncryptionInTransit { get; set; }
Property Value

IEncryptionInTransitConfig

Remarks

Default: - enabled

Stability: Experimental

InstanceType

(experimental) The EC2 instance type that you want Amazon MSK to use when it creates your brokers.

public InstanceType InstanceType { get; set; }
Property Value

InstanceType

Remarks

Default: kafka.m5.large

Stability: Experimental

See: https://docs.aws.amazon.com/msk/latest/developerguide/msk-create-cluster.html#broker-instance-types

KafkaVersion

(experimental) The version of Apache Kafka.

public KafkaVersion KafkaVersion { get; set; }
Property Value

KafkaVersion

Remarks

Stability: Experimental

Logging

(experimental) Configure your MSK cluster to send broker logs to different destination types.

public IBrokerLogging Logging { get; set; }
Property Value

IBrokerLogging

Remarks

Default: - disabled

Stability: Experimental

Monitoring

(experimental) Cluster monitoring configuration.

public IMonitoringConfiguration Monitoring { get; set; }
Property Value

IMonitoringConfiguration

Remarks

Default: - DEFAULT monitoring level

Stability: Experimental

NumberOfBrokerNodes

(experimental) Number of Apache Kafka brokers deployed in each Availability Zone.

public Nullable<double> NumberOfBrokerNodes { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Default: 1

Stability: Experimental

RemovalPolicy

(experimental) What to do when this resource is deleted from a stack.

public Nullable<RemovalPolicy> RemovalPolicy { get; set; }
Property Value

System.Nullable<RemovalPolicy>

Remarks

Default: RemovalPolicy.RETAIN

Stability: Experimental

SecurityGroups

(experimental) 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.

public ISecurityGroup[] SecurityGroups { get; set; }
Property Value

ISecurityGroup[]

Remarks

Default: - create new security group

Stability: Experimental

Vpc

(experimental) Defines the virtual networking environment for this cluster.

public IVpc Vpc { get; set; }
Property Value

IVpc

Remarks

Must have at least 2 subnets in two different AZs.

Stability: Experimental

VpcSubnets

(experimental) Where to place the nodes within the VPC.

public ISubnetSelection VpcSubnets { get; set; }
Property Value

ISubnetSelection

Remarks

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.

Default: - the Vpc default strategy if not specified.

Stability: Experimental

Implements