software.amazon.awssdk.services.mq.model

Class DescribeBrokerResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.mq.model.MQResponse

software.amazon.awssdk.services.mq.model.DescribeBrokerResponse

All Implemented Interfaces:

ToCopyableBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeBrokerResponse
extends MQResponse
implements ToCopyableBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeBrokerResponse.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	autoMinorVersionUpgrade() Required.
String	brokerArn() The Amazon Resource Name (ARN) of the broker.
String	brokerId() The unique ID that Amazon MQ generates for the broker.
List<BrokerInstance>	brokerInstances() A list of information about allocated brokers.
String	brokerName() The name of the broker.
BrokerState	brokerState() The status of the broker.
String	brokerStateAsString() The status of the broker.
static DescribeBrokerResponse.Builder	builder()
Configurations	configurations() The list of all revisions for the specified configuration.
DeploymentMode	deploymentMode() Required.
String	deploymentModeAsString() Required.
EngineType	engineType() Required.
String	engineTypeAsString() Required.
String	engineVersion() The version of the broker engine.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	hostInstanceType() The broker's instance type.
WeeklyStartTime	maintenanceWindowStartTime() The parameters that determine the WeeklyStartTime.
Boolean	publiclyAccessible() Required.
List<String>	securityGroups() Required.
static Class<? extends DescribeBrokerResponse.Builder>	serializableBuilderClass()
List<String>	subnetIds() The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones.
DescribeBrokerResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<UserSummary>	users() The list of all ActiveMQ usernames for the specified broker.

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

autoMinorVersionUpgrade

public Boolean autoMinorVersionUpgrade()

Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

Returns:

Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

brokerArn

public String brokerArn()

The Amazon Resource Name (ARN) of the broker.

Returns:

The Amazon Resource Name (ARN) of the broker.

brokerId

public String brokerId()

The unique ID that Amazon MQ generates for the broker.

Returns:

The unique ID that Amazon MQ generates for the broker.

brokerInstances

public List<BrokerInstance> brokerInstances()

A list of information about allocated brokers.

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

Returns:

A list of information about allocated brokers.

brokerName

public String brokerName()

The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

Returns:

The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

brokerState

public BrokerState brokerState()

The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS

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

Returns:

The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS

See Also:

BrokerState

brokerStateAsString

public String brokerStateAsString()

The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS

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

Returns:

The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS

See Also:

BrokerState

configurations

public Configurations configurations()

The list of all revisions for the specified configuration.

Returns:

The list of all revisions for the specified configuration.

deploymentMode

public DeploymentMode deploymentMode()

Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.

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

Returns:

Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.

See Also:

DeploymentMode

deploymentModeAsString

public String deploymentModeAsString()

Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.

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

Returns:

Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.

See Also:

DeploymentMode

engineType

public EngineType engineType()

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

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

Returns:

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

See Also:

EngineType

engineTypeAsString

public String engineTypeAsString()

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

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

Returns:

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

See Also:

EngineType

engineVersion

public String engineVersion()

The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.

Returns:

The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.

hostInstanceType

public String hostInstanceType()

The broker's instance type. Possible values: mq.t2.micro, mq.m4.large

Returns:

The broker's instance type. Possible values: mq.t2.micro, mq.m4.large

maintenanceWindowStartTime

public WeeklyStartTime maintenanceWindowStartTime()

The parameters that determine the WeeklyStartTime.

Returns:

The parameters that determine the WeeklyStartTime.

publiclyAccessible

public Boolean publiclyAccessible()

Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.

Returns:

Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.

securityGroups

public List<String> securityGroups()

Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

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

Returns:

Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

subnetIds

public List<String> subnetIds()

The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

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

Returns:

The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

users

public List<UserSummary> users()

The list of all ActiveMQ usernames for the specified broker.

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

Returns:

The list of all ActiveMQ usernames for the specified broker.

toBuilder

public DescribeBrokerResponse.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<DescribeBrokerResponse.Builder,DescribeBrokerResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeBrokerResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeBrokerResponse.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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value