interface BrokerNodeGroupInfoProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MSK.CfnCluster.BrokerNodeGroupInfoProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmsk#CfnCluster_BrokerNodeGroupInfoProperty`
Java	`software.amazon.awscdk.services.msk.CfnCluster.BrokerNodeGroupInfoProperty`
Python	`aws_cdk.aws_msk.CfnCluster.BrokerNodeGroupInfoProperty`
TypeScript	`aws-cdk-lib` » `aws_msk` » `CfnCluster` » `BrokerNodeGroupInfoProperty`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_msk as msk } from 'aws-cdk-lib';
const brokerNodeGroupInfoProperty: msk.CfnCluster.BrokerNodeGroupInfoProperty = {
  clientSubnets: ['clientSubnets'],
  instanceType: 'instanceType',

  // the properties below are optional
  brokerAzDistribution: 'brokerAzDistribution',
  connectivityInfo: {
    publicAccess: {
      type: 'type',
    },
    vpcConnectivity: {
      clientAuthentication: {
        sasl: {
          iam: {
            enabled: false,
          },
          scram: {
            enabled: false,
          },
        },
        tls: {
          enabled: false,
        },
      },
    },
  },
  securityGroups: ['securityGroups'],
  storageInfo: {
    ebsStorageInfo: {
      provisionedThroughput: {
        enabled: false,
        volumeThroughput: 123,
      },
      volumeSize: 123,
    },
  },
};

Properties

Name	Type	Description
clientSubnets	`string[]`	The list of subnets to connect to in the client virtual private cloud (VPC).
instanceType	`string`	The type of Amazon EC2 instances to use for brokers.
brokerAzDistribution?	`string`	This parameter is currently not in use.
connectivityInfo?	`IResolvable` `\|` `ConnectivityInfoProperty`	Information about the cluster's connectivity setting.
securityGroups?	`string[]`	The security groups to associate with the ENIs in order to specify who can connect to and communicate with the Amazon MSK cluster.
storageInfo?	`IResolvable` `\|` `StorageInfoProperty`	Contains information about storage volumes attached to Amazon MSK broker nodes.

clientSubnets

Type: string[]

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

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 .

instanceType

Type: string

The type of Amazon EC2 instances to use for brokers.

Depending on the broker type , Amazon MSK supports the following broker sizes:

Standard broker sizes

kafka.t3.small

You can't select the kafka.t3.small instance type when the metadata mode is KRaft.

kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge
kafka.m7g.large, kafka.m7g.xlarge, kafka.m7g.2xlarge, kafka.m7g.4xlarge, kafka.m7g.8xlarge, kafka.m7g.12xlarge, kafka.m7g.16xlarge

Express broker sizes

express.m7g.large, express.m7g.xlarge, express.m7g.2xlarge, express.m7g.4xlarge, express.m7g.8xlarge, express.m7g.12xlarge, express.m7g.16xlarge

Some broker sizes might not be available in certian AWS Regions. See the updated Pricing tools section on the Amazon MSK pricing page for the latest list of available instances by Region.

brokerAzDistribution?

Type: string (optional)

This parameter is currently not in use.

connectivityInfo?

Type: IResolvable | ConnectivityInfoProperty (optional)

Information about the cluster's connectivity setting.

securityGroups?

Type: string[] (optional)

The security groups to associate with the ENIs 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.

storageInfo?

Type: IResolvable | StorageInfoProperty (optional)

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