AWS::MSK::Cluster BrokerNodeGroupInfo - AWS CloudFormation

AWS::MSK::Cluster BrokerNodeGroupInfo

The setup to be used for brokers in the cluster.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "BrokerAZDistribution" : String, "ClientSubnets" : [ String, ... ], "InstanceType" : String, "SecurityGroups" : [ String, ... ], "StorageInfo" : StorageInfo }

Properties

BrokerAZDistribution

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets that you provide when you create the cluster.

To create a cluster, specify exactly two subnets if you are using one of the following Regions: South America (São Paulo), Canada (Central), or US West (N. California). 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.

Client subnets can't be in Availability Zone us-east-1e.

Required: No

Type: String

Update requires: Replacement

ClientSubnets

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.

Specify exactly two subnets if you are using the US West (N. California) Region. 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 be in Availability Zone us-east-1e.

Required: Yes

Type: List of String

Update requires: Replacement

InstanceType

The type of Amazon EC2 instances to use for brokers. 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, and kafka.m5.24xlarge.

Required: Yes

Type: String

Update requires: Replacement

SecurityGroups

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. 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.

Required: No

Type: List of String

Update requires: Replacement

StorageInfo

Contains information about storage volumes attached to MSK broker nodes.

Required: No

Type: StorageInfo

Update requires: Replacement