software.amazon.awssdk.services.mq.model

Interface DescribeBrokerResponse.Builder

All Superinterfaces:

CopyableBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>, MqResponse.Builder, SdkBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>

Enclosing class:

DescribeBrokerResponse

public static interface DescribeBrokerResponse.Builder
extends MqResponse.Builder, CopyableBuilder<DescribeBrokerResponse.Builder,DescribeBrokerResponse>

Method Summary

Modifier and Type	Method and Description
DescribeBrokerResponse.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Required.
DescribeBrokerResponse.Builder	brokerArn(String brokerArn) The Amazon Resource Name (ARN) of the broker.
DescribeBrokerResponse.Builder	brokerId(String brokerId) The unique ID that Amazon MQ generates for the broker.
DescribeBrokerResponse.Builder	brokerInstances(BrokerInstance... brokerInstances) A list of information about allocated brokers.
DescribeBrokerResponse.Builder	brokerInstances(Collection<BrokerInstance> brokerInstances) A list of information about allocated brokers.
DescribeBrokerResponse.Builder	brokerInstances(Consumer<BrokerInstance.Builder>... brokerInstances) A list of information about allocated brokers.
DescribeBrokerResponse.Builder	brokerName(String brokerName) The name of the broker.
DescribeBrokerResponse.Builder	brokerState(BrokerState brokerState) The status of the broker.
DescribeBrokerResponse.Builder	brokerState(String brokerState) The status of the broker.
DescribeBrokerResponse.Builder	configurations(Configurations configurations) The list of all revisions for the specified configuration.
default DescribeBrokerResponse.Builder	configurations(Consumer<Configurations.Builder> configurations) The list of all revisions for the specified configuration.
DescribeBrokerResponse.Builder	deploymentMode(DeploymentMode deploymentMode) Required.
DescribeBrokerResponse.Builder	deploymentMode(String deploymentMode) Required.
DescribeBrokerResponse.Builder	engineType(EngineType engineType) Required.
DescribeBrokerResponse.Builder	engineType(String engineType) Required.
DescribeBrokerResponse.Builder	engineVersion(String engineVersion) The version of the broker engine.
DescribeBrokerResponse.Builder	hostInstanceType(String hostInstanceType) The broker's instance type.
default DescribeBrokerResponse.Builder	maintenanceWindowStartTime(Consumer<WeeklyStartTime.Builder> maintenanceWindowStartTime) The parameters that determine the WeeklyStartTime.
DescribeBrokerResponse.Builder	maintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime) The parameters that determine the WeeklyStartTime.
DescribeBrokerResponse.Builder	publiclyAccessible(Boolean publiclyAccessible) Required.
DescribeBrokerResponse.Builder	securityGroups(Collection<String> securityGroups) Required.
DescribeBrokerResponse.Builder	securityGroups(String... securityGroups) Required.
DescribeBrokerResponse.Builder	subnetIds(Collection<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	subnetIds(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	users(Collection<UserSummary> users) The list of all ActiveMQ usernames for the specified broker.
DescribeBrokerResponse.Builder	users(Consumer<UserSummary.Builder>... users) The list of all ActiveMQ usernames for the specified broker.
DescribeBrokerResponse.Builder	users(UserSummary... users) The list of all ActiveMQ usernames for the specified broker.

Methods inherited from interface software.amazon.awssdk.services.mq.model.MqResponse.Builder

build

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

copy

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

applyMutation, build

Method Detail

autoMinorVersionUpgrade

DescribeBrokerResponse.Builder autoMinorVersionUpgrade(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.

Parameters:

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:

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

brokerArn

DescribeBrokerResponse.Builder brokerArn(String brokerArn)

The Amazon Resource Name (ARN) of the broker.

Parameters:

brokerArn - The Amazon Resource Name (ARN) of the broker.

Returns:

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

brokerId

DescribeBrokerResponse.Builder brokerId(String brokerId)

The unique ID that Amazon MQ generates for the broker.

Parameters:

brokerId - The unique ID that Amazon MQ generates for the broker.

Returns:

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

brokerInstances

DescribeBrokerResponse.Builder brokerInstances(Collection<BrokerInstance> brokerInstances)

A list of information about allocated brokers.

Parameters:

brokerInstances - A list of information about allocated brokers.

Returns:

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

brokerInstances

DescribeBrokerResponse.Builder brokerInstances(BrokerInstance... brokerInstances)

A list of information about allocated brokers.

Parameters:

brokerInstances - A list of information about allocated brokers.

Returns:

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

brokerInstances

DescribeBrokerResponse.Builder brokerInstances(Consumer<BrokerInstance.Builder>... brokerInstances)

A list of information about allocated brokers. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via #builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #brokerInstances(List).

Parameters:

brokerInstances - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#brokerInstances(List)

brokerName

DescribeBrokerResponse.Builder brokerName(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.

Parameters:

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:

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

brokerState

DescribeBrokerResponse.Builder brokerState(String brokerState)

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

Parameters:

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

Returns:

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

See Also:

BrokerState, BrokerState

brokerState

DescribeBrokerResponse.Builder brokerState(BrokerState brokerState)

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

Parameters:

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

Returns:

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

See Also:

BrokerState, BrokerState

configurations

DescribeBrokerResponse.Builder configurations(Configurations configurations)

The list of all revisions for the specified configuration.

Parameters:

configurations - The list of all revisions for the specified configuration.

Returns:

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

configurations

default DescribeBrokerResponse.Builder configurations(Consumer<Configurations.Builder> configurations)

The list of all revisions for the specified configuration. This is a convenience that creates an instance of the Configurations.Builder avoiding the need to create one manually via Configurations.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configurations(Configurations).

Parameters:

configurations - a consumer that will call methods on Configurations.Builder

Returns:

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

See Also:

configurations(Configurations)

deploymentMode

DescribeBrokerResponse.Builder deploymentMode(String 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.

Parameters:

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.

Returns:

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

See Also:

DeploymentMode, DeploymentMode

deploymentMode

DescribeBrokerResponse.Builder deploymentMode(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.

Parameters:

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.

Returns:

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

See Also:

DeploymentMode, DeploymentMode

engineType

DescribeBrokerResponse.Builder engineType(String engineType)

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

Parameters:

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

Returns:

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

See Also:

EngineType, EngineType

engineType

DescribeBrokerResponse.Builder engineType(EngineType engineType)

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

Parameters:

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

Returns:

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

See Also:

EngineType, EngineType

engineVersion

DescribeBrokerResponse.Builder engineVersion(String engineVersion)

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

Parameters:

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

Returns:

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

hostInstanceType

DescribeBrokerResponse.Builder hostInstanceType(String hostInstanceType)

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

Parameters:

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

Returns:

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

maintenanceWindowStartTime

DescribeBrokerResponse.Builder maintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)

The parameters that determine the WeeklyStartTime.

Parameters:

maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.

Returns:

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

maintenanceWindowStartTime

default DescribeBrokerResponse.Builder maintenanceWindowStartTime(Consumer<WeeklyStartTime.Builder> maintenanceWindowStartTime)

The parameters that determine the WeeklyStartTime. This is a convenience that creates an instance of the WeeklyStartTime.Builder avoiding the need to create one manually via WeeklyStartTime.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to maintenanceWindowStartTime(WeeklyStartTime).

Parameters:

maintenanceWindowStartTime - a consumer that will call methods on WeeklyStartTime.Builder

Returns:

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

See Also:

maintenanceWindowStartTime(WeeklyStartTime)

publiclyAccessible

DescribeBrokerResponse.Builder publiclyAccessible(Boolean publiclyAccessible)

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

Parameters:

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

Returns:

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

securityGroups

DescribeBrokerResponse.Builder securityGroups(Collection<String> securityGroups)

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

Parameters:

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

Returns:

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

securityGroups

DescribeBrokerResponse.Builder securityGroups(String... securityGroups)

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

Parameters:

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

Returns:

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

subnetIds

DescribeBrokerResponse.Builder subnetIds(Collection<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.

Parameters:

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.

Returns:

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

subnetIds

DescribeBrokerResponse.Builder subnetIds(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.

Parameters:

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.

Returns:

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

users

DescribeBrokerResponse.Builder users(Collection<UserSummary> users)

The list of all ActiveMQ usernames for the specified broker.

Parameters:

users - The list of all ActiveMQ usernames for the specified broker.

Returns:

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

users

DescribeBrokerResponse.Builder users(UserSummary... users)

The list of all ActiveMQ usernames for the specified broker.

Parameters:

users - The list of all ActiveMQ usernames for the specified broker.

Returns:

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

users

DescribeBrokerResponse.Builder users(Consumer<UserSummary.Builder>... users)

The list of all ActiveMQ usernames for the specified broker. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via #builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #users(List).

Parameters:

users - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#users(List)