Interface IClusterProps
(experimental) Properties for a MSK Cluster.
Namespace: Amazon.CDK.AWS.MSK
Assembly: Amazon.CDK.AWS.MSK.dll
Syntax (csharp)
public interface IClusterProps
Syntax (vb)
Public Interface 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
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. |
Properties
ClientAuthentication
(experimental) Configuration properties for client authentication.
virtual ClientAuthentication ClientAuthentication { get; }
Property Value
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.
string ClusterName { get; }
Property Value
System.String
Remarks
Stability: Experimental
ConfigurationInfo
(experimental) The Amazon MSK configuration to use for the cluster.
virtual IClusterConfigurationInfo ConfigurationInfo { get; }
Property Value
Remarks
Default: - none
Stability: Experimental
EbsStorageInfo
(experimental) Information about storage volumes attached to MSK broker nodes.
virtual IEbsStorageInfo EbsStorageInfo { get; }
Property Value
Remarks
Default: - 1000 GiB EBS volume
Stability: Experimental
EncryptionInTransit
(experimental) Config details for encryption in transit.
virtual IEncryptionInTransitConfig EncryptionInTransit { get; }
Property Value
Remarks
Default: - enabled
Stability: Experimental
InstanceType
(experimental) The EC2 instance type that you want Amazon MSK to use when it creates your brokers.
virtual InstanceType InstanceType { get; }
Property Value
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.
KafkaVersion KafkaVersion { get; }
Property Value
Remarks
Stability: Experimental
Logging
(experimental) Configure your MSK cluster to send broker logs to different destination types.
virtual IBrokerLogging Logging { get; }
Property Value
Remarks
Default: - disabled
Stability: Experimental
Monitoring
(experimental) Cluster monitoring configuration.
virtual IMonitoringConfiguration Monitoring { get; }
Property Value
Remarks
Default: - DEFAULT monitoring level
Stability: Experimental
NumberOfBrokerNodes
(experimental) Number of Apache Kafka brokers deployed in each Availability Zone.
virtual Nullable<double> NumberOfBrokerNodes { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
Stability: Experimental
RemovalPolicy
(experimental) What to do when this resource is deleted from a stack.
virtual Nullable<RemovalPolicy> RemovalPolicy { get; }
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.
virtual ISecurityGroup[] SecurityGroups { get; }
Property Value
Remarks
Default: - create new security group
Stability: Experimental
Vpc
(experimental) Defines the virtual networking environment for this cluster.
IVpc Vpc { get; }
Property Value
Remarks
Must have at least 2 subnets in two different AZs.
Stability: Experimental
VpcSubnets
(experimental) Where to place the nodes within the VPC.
virtual ISubnetSelection VpcSubnets { get; }
Property Value
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