Skip to content

BrokerNodeGroupInfo

Used by
Source code in docs_src/capo_kafka/types/broker_node_group_info.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class BrokerNodeGroupInfo(TypedDict, closed=True):
    broker_az_distribution: NotRequired[
        "capo_kafka.types.broker_az_distribution.BrokerAZDistribution"
    ]
    """<p>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.</p> <p>Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.</p>"""
    client_subnets: NotRequired["capo_kafka.types.__list_of__string.__listOf__string"]
    """<p>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. Client subnets can't occupy the Availability Zone with ID use use1-az3.</p>"""
    instance_type: NotRequired["capo_kafka.types.__string_min5_max32.__stringMin5Max32"]
    """<p>The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.</p>"""
    security_groups: NotRequired["capo_kafka.types.__list_of__string.__listOf__string"]
    """<p>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.</p>"""
    storage_info: NotRequired["capo_kafka.types.storage_info.StorageInfo"]
    """<p>Contains information about storage volumes attached to MSK broker nodes.</p>"""
    connectivity_info: NotRequired[
        "capo_kafka.types.connectivity_info.ConnectivityInfo"
    ]
    """<p>Information about the broker access configuration.</p>"""
    zone_ids: NotRequired["capo_kafka.types.__list_of__string.__listOf__string"]
    """<p>The list of zoneIds for the cluster in the virtual private cloud (VPC).</p>"""

broker_az_distribution instance-attribute 

broker_az_distribution: NotRequired[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 you provide when you create the cluster.

client_subnets instance-attribute 

client_subnets: NotRequired[__listOf__string]

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. Client subnets can't occupy the Availability Zone with ID use use1-az3.

connectivity_info instance-attribute 

connectivity_info: NotRequired[ConnectivityInfo]

Information about the broker access configuration.

instance_type instance-attribute 

instance_type: NotRequired[__stringMin5Max32]

The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

security_groups instance-attribute 

security_groups: NotRequired[__listOf__string]

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.

storage_info instance-attribute 

storage_info: NotRequired[StorageInfo]

Contains information about storage volumes attached to MSK broker nodes.

zone_ids instance-attribute 

zone_ids: NotRequired[__listOf__string]

The list of zoneIds for the cluster in the virtual private cloud (VPC).