software.amazon.awssdk.services.kafka.model

Class BrokerNodeGroupInfo

java.lang.Object

software.amazon.awssdk.services.kafka.model.BrokerNodeGroupInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BrokerNodeGroupInfo.Builder,BrokerNodeGroupInfo>

@Generated(value="software.amazon.awssdk:codegen")
public final class BrokerNodeGroupInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BrokerNodeGroupInfo.Builder,BrokerNodeGroupInfo>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BrokerNodeGroupInfo.Builder

Method Summary

Modifier and Type	Method and Description
BrokerAZDistribution	brokerAZDistribution() The distribution of broker nodes across Availability Zones.
String	brokerAZDistributionAsString() The distribution of broker nodes across Availability Zones.
static BrokerNodeGroupInfo.Builder	builder()
List<String>	clientSubnets() The list of subnets to connect to in the client virtual private cloud (VPC).
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceType() The type of Amazon EC2 instances to use for Kafka brokers.
List<SdkField<?>>	sdkFields()
List<String>	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.
static Class<? extends BrokerNodeGroupInfo.Builder>	serializableBuilderClass()
StorageInfo	storageInfo() Contains information about storage volumes attached to MSK broker nodes.
BrokerNodeGroupInfo.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

brokerAZDistribution

public BrokerAZDistribution brokerAZDistribution()

The distribution of broker nodes across Availability Zones.

If the service returns an enum value that is not available in the current SDK version, brokerAZDistribution will return BrokerAZDistribution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from brokerAZDistributionAsString().

Returns:

The distribution of broker nodes across Availability Zones.

See Also:

BrokerAZDistribution

brokerAZDistributionAsString

public String brokerAZDistributionAsString()

The distribution of broker nodes across Availability Zones.

If the service returns an enum value that is not available in the current SDK version, brokerAZDistribution will return BrokerAZDistribution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from brokerAZDistributionAsString().

Returns:

The distribution of broker nodes across Availability Zones.

See Also:

BrokerAZDistribution

clientSubnets

public List<String> 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 be in Availability Zone us-east-1e.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 be in Availability Zone us-east-1e.

instanceType

public String instanceType()

The type of Amazon EC2 instances to use for 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.

Returns:

The type of Amazon EC2 instances to use for 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.

securityGroups

public List<String> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

storageInfo

public StorageInfo storageInfo()

Contains information about storage volumes attached to MSK broker nodes.

Returns:

Contains information about storage volumes attached to MSK broker nodes.

toBuilder

public BrokerNodeGroupInfo.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<BrokerNodeGroupInfo.Builder,BrokerNodeGroupInfo>

Returns:

a builder for type T

builder

public static BrokerNodeGroupInfo.Builder builder()

serializableBuilderClass

public static Class<? extends BrokerNodeGroupInfo.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.