Skip to content

/AWS1/CL_KFKBROKERNODEGRPINFO

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

CONSTRUCTOR

IMPORTING

Required arguments:

IT_CLIENTSUBNETS TYPE /AWS1/CL_KFK__LISTOF__STRING_W=>TT___LISTOF__STRING TT___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.

IV_INSTANCETYPE TYPE /AWS1/KFK__STRINGMIN5MAX32 /AWS1/KFK__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.

Optional arguments:

IV_BROKERAZDISTRIBUTION TYPE /AWS1/KFKBROKERAZDISTRIBUTION /AWS1/KFKBROKERAZDISTRIBUTION

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.

IT_SECURITYGROUPS TYPE /AWS1/CL_KFK__LISTOF__STRING_W=>TT___LISTOF__STRING TT___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.

IO_STORAGEINFO TYPE REF TO /AWS1/CL_KFKSTORAGEINFO /AWS1/CL_KFKSTORAGEINFO

Contains information about storage volumes attached to MSK broker nodes.

IO_CONNECTIVITYINFO TYPE REF TO /AWS1/CL_KFKCONNECTIVITYINFO /AWS1/CL_KFKCONNECTIVITYINFO

Information about the broker access configuration.

IT_ZONEIDS TYPE /AWS1/CL_KFK__LISTOF__STRING_W=>TT___LISTOF__STRING TT___LISTOF__STRING

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


Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_BROKERAZDISTRIBUTION() Getter for BROKERAZDISTRIBUTION, with configurable default
ASK_BROKERAZDISTRIBUTION() Getter for BROKERAZDISTRIBUTION w/ exceptions if field has n
HAS_BROKERAZDISTRIBUTION() Determine if BROKERAZDISTRIBUTION has a value

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

Accessible with the following methods

Method Description
GET_CLIENTSUBNETS() Getter for CLIENTSUBNETS, with configurable default
ASK_CLIENTSUBNETS() Getter for CLIENTSUBNETS w/ exceptions if field has no value
HAS_CLIENTSUBNETS() Determine if CLIENTSUBNETS has a value

InstanceType

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.

Accessible with the following methods

Method Description
GET_INSTANCETYPE() Getter for INSTANCETYPE, with configurable default
ASK_INSTANCETYPE() Getter for INSTANCETYPE w/ exceptions if field has no value
HAS_INSTANCETYPE() Determine if INSTANCETYPE has a value

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.

Accessible with the following methods

Method Description
GET_SECURITYGROUPS() Getter for SECURITYGROUPS, with configurable default
ASK_SECURITYGROUPS() Getter for SECURITYGROUPS w/ exceptions if field has no valu
HAS_SECURITYGROUPS() Determine if SECURITYGROUPS has a value

StorageInfo

Contains information about storage volumes attached to MSK broker nodes.

Accessible with the following methods

Method Description
GET_STORAGEINFO() Getter for STORAGEINFO

ConnectivityInfo

Information about the broker access configuration.

Accessible with the following methods

Method Description
GET_CONNECTIVITYINFO() Getter for CONNECTIVITYINFO

ZoneIds

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

Accessible with the following methods

Method Description
GET_ZONEIDS() Getter for ZONEIDS, with configurable default
ASK_ZONEIDS() Getter for ZONEIDS w/ exceptions if field has no value
HAS_ZONEIDS() Determine if ZONEIDS has a value