Interface AwsAmazonMqBrokerDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AwsAmazonMqBrokerDetails.Builder,AwsAmazonMqBrokerDetails>, SdkBuilder<AwsAmazonMqBrokerDetails.Builder,AwsAmazonMqBrokerDetails>, SdkPojo

Enclosing class:

AwsAmazonMqBrokerDetails

public static interface AwsAmazonMqBrokerDetails.Builder
extends SdkPojo, CopyableBuilder<AwsAmazonMqBrokerDetails.Builder,AwsAmazonMqBrokerDetails>

Method Summary

Modifier and Type	Method	Description
AwsAmazonMqBrokerDetails.Builder	authenticationStrategy(String authenticationStrategy)	The authentication strategy used to secure the broker.
AwsAmazonMqBrokerDetails.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ.
AwsAmazonMqBrokerDetails.Builder	brokerArn(String brokerArn)	The Amazon Resource Name (ARN) of the broker.
AwsAmazonMqBrokerDetails.Builder	brokerId(String brokerId)	The unique ID that Amazon MQ generates for the broker.
AwsAmazonMqBrokerDetails.Builder	brokerName(String brokerName)	The broker's name.
AwsAmazonMqBrokerDetails.Builder	deploymentMode(String deploymentMode)	The broker's deployment mode.
default AwsAmazonMqBrokerDetails.Builder	encryptionOptions(Consumer<AwsAmazonMqBrokerEncryptionOptionsDetails.Builder> encryptionOptions)	Encryption options for the broker.
AwsAmazonMqBrokerDetails.Builder	encryptionOptions(AwsAmazonMqBrokerEncryptionOptionsDetails encryptionOptions)	Encryption options for the broker.
AwsAmazonMqBrokerDetails.Builder	engineType(String engineType)	The type of broker engine.
AwsAmazonMqBrokerDetails.Builder	engineVersion(String engineVersion)	The version of the broker engine.
AwsAmazonMqBrokerDetails.Builder	hostInstanceType(String hostInstanceType)	The broker's instance type.
default AwsAmazonMqBrokerDetails.Builder	ldapServerMetadata(Consumer<AwsAmazonMqBrokerLdapServerMetadataDetails.Builder> ldapServerMetadata)	The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker.
AwsAmazonMqBrokerDetails.Builder	ldapServerMetadata(AwsAmazonMqBrokerLdapServerMetadataDetails ldapServerMetadata)	The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker.
default AwsAmazonMqBrokerDetails.Builder	logs(Consumer<AwsAmazonMqBrokerLogsDetails.Builder> logs)	Turns on Amazon CloudWatch logging for brokers.
AwsAmazonMqBrokerDetails.Builder	logs(AwsAmazonMqBrokerLogsDetails logs)	Turns on Amazon CloudWatch logging for brokers.
default AwsAmazonMqBrokerDetails.Builder	maintenanceWindowStartTime(Consumer<AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails.Builder> maintenanceWindowStartTime)	The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
AwsAmazonMqBrokerDetails.Builder	maintenanceWindowStartTime(AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails maintenanceWindowStartTime)	The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
AwsAmazonMqBrokerDetails.Builder	publiclyAccessible(Boolean publiclyAccessible)	Permits connections from applications outside of the VPC that hosts the broker's subnets.
AwsAmazonMqBrokerDetails.Builder	securityGroups(String... securityGroups)	The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
AwsAmazonMqBrokerDetails.Builder	securityGroups(Collection<String> securityGroups)	The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
AwsAmazonMqBrokerDetails.Builder	storageType(String storageType)	The broker's storage type.
AwsAmazonMqBrokerDetails.Builder	subnetIds(String... subnetIds)	The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
AwsAmazonMqBrokerDetails.Builder	subnetIds(Collection<String> subnetIds)	The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
AwsAmazonMqBrokerDetails.Builder	users(Collection<AwsAmazonMqBrokerUsersDetails> users)	The list of all broker usernames for the specified broker.
AwsAmazonMqBrokerDetails.Builder	users(Consumer<AwsAmazonMqBrokerUsersDetails.Builder>... users)	The list of all broker usernames for the specified broker.
AwsAmazonMqBrokerDetails.Builder	users(AwsAmazonMqBrokerUsersDetails... users)	The list of all broker usernames for the specified broker.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

authenticationStrategy

AwsAmazonMqBrokerDetails.Builder authenticationStrategy(String authenticationStrategy)

The authentication strategy used to secure the broker. The default is SIMPLE.

Parameters:

authenticationStrategy - The authentication strategy used to secure the broker. The default is SIMPLE.

Returns:

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

autoMinorVersionUpgrade

AwsAmazonMqBrokerDetails.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

Parameters:

autoMinorVersionUpgrade - Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled 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

AwsAmazonMqBrokerDetails.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.

brokerName

AwsAmazonMqBrokerDetails.Builder brokerName(String brokerName)

The broker's name.

Parameters:

brokerName - The broker's name.

Returns:

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

deploymentMode

AwsAmazonMqBrokerDetails.Builder deploymentMode(String deploymentMode)

The broker's deployment mode.

Parameters:

deploymentMode - The broker's deployment mode.

Returns:

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

encryptionOptions

AwsAmazonMqBrokerDetails.Builder encryptionOptions(AwsAmazonMqBrokerEncryptionOptionsDetails encryptionOptions)

Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.

Parameters:

encryptionOptions - Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.

Returns:

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

encryptionOptions

default AwsAmazonMqBrokerDetails.Builder encryptionOptions(Consumer<AwsAmazonMqBrokerEncryptionOptionsDetails.Builder> encryptionOptions)

Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.

This is a convenience method that creates an instance of the AwsAmazonMqBrokerEncryptionOptionsDetails.Builder avoiding the need to create one manually via AwsAmazonMqBrokerEncryptionOptionsDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionOptions(AwsAmazonMqBrokerEncryptionOptionsDetails).

Parameters:

encryptionOptions - a consumer that will call methods on AwsAmazonMqBrokerEncryptionOptionsDetails.Builder

Returns:

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

See Also:

• encryptionOptions(AwsAmazonMqBrokerEncryptionOptionsDetails)

engineType

AwsAmazonMqBrokerDetails.Builder engineType(String engineType)

The type of broker engine.

Parameters:

engineType - The type of broker engine.

Returns:

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

engineVersion

AwsAmazonMqBrokerDetails.Builder engineVersion(String engineVersion)

The version of the broker engine.

Parameters:

engineVersion - The version of the broker engine.

Returns:

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

hostInstanceType

AwsAmazonMqBrokerDetails.Builder hostInstanceType(String hostInstanceType)

The broker's instance type.

Parameters:

hostInstanceType - The broker's instance type.

Returns:

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

brokerId

AwsAmazonMqBrokerDetails.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.

ldapServerMetadata

AwsAmazonMqBrokerDetails.Builder ldapServerMetadata(AwsAmazonMqBrokerLdapServerMetadataDetails ldapServerMetadata)

The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

Parameters:

ldapServerMetadata - The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

Returns:

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

ldapServerMetadata

default AwsAmazonMqBrokerDetails.Builder ldapServerMetadata(Consumer<AwsAmazonMqBrokerLdapServerMetadataDetails.Builder> ldapServerMetadata)

The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

This is a convenience method that creates an instance of the AwsAmazonMqBrokerLdapServerMetadataDetails.Builder avoiding the need to create one manually via AwsAmazonMqBrokerLdapServerMetadataDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ldapServerMetadata(AwsAmazonMqBrokerLdapServerMetadataDetails).

Parameters:

ldapServerMetadata - a consumer that will call methods on AwsAmazonMqBrokerLdapServerMetadataDetails.Builder

Returns:

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

See Also:

• ldapServerMetadata(AwsAmazonMqBrokerLdapServerMetadataDetails)

logs

AwsAmazonMqBrokerDetails.Builder logs(AwsAmazonMqBrokerLogsDetails logs)

Turns on Amazon CloudWatch logging for brokers.

Parameters:

logs - Turns on Amazon CloudWatch logging for brokers.

Returns:

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

logs

default AwsAmazonMqBrokerDetails.Builder logs(Consumer<AwsAmazonMqBrokerLogsDetails.Builder> logs)

Turns on Amazon CloudWatch logging for brokers.

This is a convenience method that creates an instance of the AwsAmazonMqBrokerLogsDetails.Builder avoiding the need to create one manually via AwsAmazonMqBrokerLogsDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logs(AwsAmazonMqBrokerLogsDetails).

Parameters:

logs - a consumer that will call methods on AwsAmazonMqBrokerLogsDetails.Builder

Returns:

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

See Also:

• logs(AwsAmazonMqBrokerLogsDetails)

maintenanceWindowStartTime

AwsAmazonMqBrokerDetails.Builder maintenanceWindowStartTime(AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails maintenanceWindowStartTime)

The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.

Parameters:

maintenanceWindowStartTime - The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.

Returns:

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

maintenanceWindowStartTime

default AwsAmazonMqBrokerDetails.Builder maintenanceWindowStartTime(Consumer<AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails.Builder> maintenanceWindowStartTime)

The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.

This is a convenience method that creates an instance of the AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails.Builder avoiding the need to create one manually via AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to maintenanceWindowStartTime(AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails).

Parameters:

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

Returns:

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

See Also:

• maintenanceWindowStartTime(AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails)

publiclyAccessible

AwsAmazonMqBrokerDetails.Builder publiclyAccessible(Boolean publiclyAccessible)

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

Parameters:

publiclyAccessible - Permits 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

AwsAmazonMqBrokerDetails.Builder securityGroups(Collection<String> securityGroups)

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

Parameters:

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

Returns:

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

securityGroups

AwsAmazonMqBrokerDetails.Builder securityGroups(String... securityGroups)

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

Parameters:

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

Returns:

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

storageType

AwsAmazonMqBrokerDetails.Builder storageType(String storageType)

The broker's storage type.

Parameters:

storageType - The broker's storage type.

Returns:

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

subnetIds

AwsAmazonMqBrokerDetails.Builder subnetIds(Collection<String> subnetIds)

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

Parameters:

subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

Returns:

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

subnetIds

AwsAmazonMqBrokerDetails.Builder subnetIds(String... subnetIds)

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

Parameters:

subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

Returns:

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

users

AwsAmazonMqBrokerDetails.Builder users(Collection<AwsAmazonMqBrokerUsersDetails> users)

The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

Parameters:

users - The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

Returns:

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

users

AwsAmazonMqBrokerDetails.Builder users(AwsAmazonMqBrokerUsersDetails... users)

The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

Parameters:

users - The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

Returns:

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

users

AwsAmazonMqBrokerDetails.Builder users(Consumer<AwsAmazonMqBrokerUsersDetails.Builder>... users)

The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

This is a convenience method that creates an instance of the AwsAmazonMqBrokerUsersDetails.Builder avoiding the need to create one manually via AwsAmazonMqBrokerUsersDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to users(List<AwsAmazonMqBrokerUsersDetails>).

Parameters:

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

Returns:

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

See Also:

• users(java.util.Collection<AwsAmazonMqBrokerUsersDetails>)