Interface CfnCluster.IBrokerNodeGroupInfoProperty

Describes the setup to be used for the broker nodes in the cluster.

Namespace: Amazon.CDK.AWS.MSK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBrokerNodeGroupInfoProperty
Syntax (vb)
Public Interface IBrokerNodeGroupInfoProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MSK;

var brokerNodeGroupInfoProperty = new BrokerNodeGroupInfoProperty {
    ClientSubnets = new [] { "clientSubnets" },
    InstanceType = "instanceType",

    // the properties below are optional
    BrokerAzDistribution = "brokerAzDistribution",
    ConnectivityInfo = new ConnectivityInfoProperty {
        PublicAccess = new PublicAccessProperty {
            Type = "type"
        },
        VpcConnectivity = new VpcConnectivityProperty {
            ClientAuthentication = new VpcConnectivityClientAuthenticationProperty {
                Sasl = new VpcConnectivitySaslProperty {
                    Iam = new VpcConnectivityIamProperty {
                        Enabled = false
                    },
                    Scram = new VpcConnectivityScramProperty {
                        Enabled = false
                    }
                },
                Tls = new VpcConnectivityTlsProperty {
                    Enabled = false
                }
            }
        }
    },
    SecurityGroups = new [] { "securityGroups" },
    StorageInfo = new StorageInfoProperty {
        EbsStorageInfo = new EBSStorageInfoProperty {
            ProvisionedThroughput = new ProvisionedThroughputProperty {
                Enabled = false,
                VolumeThroughput = 123
            },
            VolumeSize = 123
        }
    }
};

Synopsis

Properties

BrokerAzDistribution

This parameter is currently not in use.
ClientSubnets

The list of subnets to connect to in the client virtual private cloud (VPC).
ConnectivityInfo

Information about the cluster's connectivity setting.
InstanceType

The type of Amazon EC2 instances to use for brokers.
SecurityGroups

The security groups to associate with the ENIs in order to specify who can connect to and communicate with the Amazon MSK cluster.
StorageInfo

Contains information about storage volumes attached to Amazon MSK broker nodes.

Properties

BrokerAzDistribution

This parameter is currently not in use.

virtual string BrokerAzDistribution { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-brokerazdistribution

ClientSubnets

The list of subnets to connect to in the client virtual private cloud (VPC).

string[] ClientSubnets { get; }
Property Value

System.String[]

Remarks

Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs to produce and consume data.

If you use the US West (N. California) Region, specify exactly two subnets. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify.

Client subnets can't occupy the Availability Zone with ID use1-az3 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-clientsubnets

ConnectivityInfo

Information about the cluster's connectivity setting.

virtual object ConnectivityInfo { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-connectivityinfo

InstanceType

The type of Amazon EC2 instances to use for brokers.

string InstanceType { get; }
Property Value

System.String

Remarks

The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-instancetype

SecurityGroups

The security groups to associate with the ENIs in order to specify who can connect to and communicate with the Amazon MSK cluster.

virtual string[] SecurityGroups { get; }
Property Value

System.String[]

Remarks

If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-securitygroups

StorageInfo

Contains information about storage volumes attached to Amazon MSK broker nodes.

virtual object StorageInfo { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-brokernodegroupinfo.html#cfn-msk-cluster-brokernodegroupinfo-storageinfo