com.amazonaws.services.kafka.model

Class BrokerNodeGroupInfo

java.lang.Object

com.amazonaws.services.kafka.model.BrokerNodeGroupInfo

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BrokerNodeGroupInfo
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BrokerNodeGroupInfo()

Method Summary

Modifier and Type	Method and Description
BrokerNodeGroupInfo	clone()
boolean	equals(Object obj)
String	getBrokerAZDistribution() The distribution of broker nodes across Availability Zones.
List<String>	getClientSubnets() The list of subnets to connect to in the client virtual private cloud (VPC).
ConnectivityInfo	getConnectivityInfo() Information about the broker access configuration.
String	getInstanceType() The type of Amazon EC2 instances to use for Apache Kafka brokers.
List<String>	getSecurityGroups() 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	getStorageInfo() Contains information about storage volumes attached to MSK broker nodes.
List<String>	getZoneIds() The list of zoneIds for the cluster in the virtual private cloud (VPC).
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBrokerAZDistribution(String brokerAZDistribution) The distribution of broker nodes across Availability Zones.
void	setClientSubnets(Collection<String> clientSubnets) The list of subnets to connect to in the client virtual private cloud (VPC).
void	setConnectivityInfo(ConnectivityInfo connectivityInfo) Information about the broker access configuration.
void	setInstanceType(String instanceType) The type of Amazon EC2 instances to use for Apache Kafka brokers.
void	setSecurityGroups(Collection<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.
void	setStorageInfo(StorageInfo storageInfo) Contains information about storage volumes attached to MSK broker nodes.
void	setZoneIds(Collection<String> zoneIds) The list of zoneIds for the cluster in the virtual private cloud (VPC).
String	toString() Returns a string representation of this object.
BrokerNodeGroupInfo	withBrokerAZDistribution(BrokerAZDistribution brokerAZDistribution) The distribution of broker nodes across Availability Zones.
BrokerNodeGroupInfo	withBrokerAZDistribution(String brokerAZDistribution) The distribution of broker nodes across Availability Zones.
BrokerNodeGroupInfo	withClientSubnets(Collection<String> clientSubnets) The list of subnets to connect to in the client virtual private cloud (VPC).
BrokerNodeGroupInfo	withClientSubnets(String... clientSubnets) The list of subnets to connect to in the client virtual private cloud (VPC).
BrokerNodeGroupInfo	withConnectivityInfo(ConnectivityInfo connectivityInfo) Information about the broker access configuration.
BrokerNodeGroupInfo	withInstanceType(String instanceType) The type of Amazon EC2 instances to use for Apache Kafka brokers.
BrokerNodeGroupInfo	withSecurityGroups(Collection<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.
BrokerNodeGroupInfo	withSecurityGroups(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.
BrokerNodeGroupInfo	withStorageInfo(StorageInfo storageInfo) Contains information about storage volumes attached to MSK broker nodes.
BrokerNodeGroupInfo	withZoneIds(Collection<String> zoneIds) The list of zoneIds for the cluster in the virtual private cloud (VPC).
BrokerNodeGroupInfo	withZoneIds(String... zoneIds) The list of zoneIds for the cluster in the virtual private cloud (VPC).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BrokerNodeGroupInfo

public BrokerNodeGroupInfo()

Method Detail

setBrokerAZDistribution

public void setBrokerAZDistribution(String 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.

Parameters:

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.

See Also:

BrokerAZDistribution

getBrokerAZDistribution

public String getBrokerAZDistribution()

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.

Returns:

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.

See Also:

BrokerAZDistribution

withBrokerAZDistribution

public BrokerNodeGroupInfo withBrokerAZDistribution(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BrokerAZDistribution

withBrokerAZDistribution

public BrokerNodeGroupInfo withBrokerAZDistribution(BrokerAZDistribution 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BrokerAZDistribution

getClientSubnets

public List<String> getClientSubnets()

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.

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 occupy the Availability Zone with ID use use1-az3.

setClientSubnets

public void setClientSubnets(Collection<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 occupy the Availability Zone with ID use use1-az3.

Parameters:

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.

withClientSubnets

public BrokerNodeGroupInfo withClientSubnets(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 occupy the Availability Zone with ID use use1-az3.

NOTE: This method appends the values to the existing list (if any). Use setClientSubnets(java.util.Collection) or withClientSubnets(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withClientSubnets

public BrokerNodeGroupInfo withClientSubnets(Collection<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 occupy the Availability Zone with ID use use1-az3.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceType

public void setInstanceType(String 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.

Parameters:

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.

getInstanceType

public String getInstanceType()

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.

Returns:

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.

withInstanceType

public BrokerNodeGroupInfo withInstanceType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSecurityGroups

public List<String> getSecurityGroups()

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.

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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

setSecurityGroups

public void setSecurityGroups(Collection<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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

Parameters:

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.

withSecurityGroups

public BrokerNodeGroupInfo withSecurityGroups(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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityGroups

public BrokerNodeGroupInfo withSecurityGroups(Collection<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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStorageInfo

public void setStorageInfo(StorageInfo storageInfo)

Contains information about storage volumes attached to MSK broker nodes.

Parameters:

storageInfo -

Contains information about storage volumes attached to MSK broker nodes.

getStorageInfo

public StorageInfo getStorageInfo()

Contains information about storage volumes attached to MSK broker nodes.

Returns:

Contains information about storage volumes attached to MSK broker nodes.

withStorageInfo

public BrokerNodeGroupInfo withStorageInfo(StorageInfo storageInfo)

Contains information about storage volumes attached to MSK broker nodes.

Parameters:

storageInfo -

Contains information about storage volumes attached to MSK broker nodes.

Returns:

Returns a reference to this object so that method calls can be chained together.

setConnectivityInfo

public void setConnectivityInfo(ConnectivityInfo connectivityInfo)

Information about the broker access configuration.

Parameters:

connectivityInfo -

Information about the broker access configuration.

getConnectivityInfo

public ConnectivityInfo getConnectivityInfo()

Information about the broker access configuration.

Returns:

Information about the broker access configuration.

withConnectivityInfo

public BrokerNodeGroupInfo withConnectivityInfo(ConnectivityInfo connectivityInfo)

Information about the broker access configuration.

Parameters:

connectivityInfo -

Information about the broker access configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

getZoneIds

public List<String> getZoneIds()

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

Returns:

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

setZoneIds

public void setZoneIds(Collection<String> zoneIds)

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

Parameters:

zoneIds -

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

withZoneIds

public BrokerNodeGroupInfo withZoneIds(String... zoneIds)

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

NOTE: This method appends the values to the existing list (if any). Use setZoneIds(java.util.Collection) or withZoneIds(java.util.Collection) if you want to override the existing values.

Parameters:

zoneIds -

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withZoneIds

public BrokerNodeGroupInfo withZoneIds(Collection<String> zoneIds)

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

Parameters:

zoneIds -

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BrokerNodeGroupInfo clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.