public static interface CreateBrokerRequest.Builder extends MqRequest.Builder, SdkPojo, CopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>
Modifier and Type | Method and Description |
---|---|
CreateBrokerRequest.Builder |
authenticationStrategy(AuthenticationStrategy authenticationStrategy)
The authentication strategy used to secure the broker.
|
CreateBrokerRequest.Builder |
authenticationStrategy(String authenticationStrategy)
The authentication strategy used to secure the broker.
|
CreateBrokerRequest.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Required.
|
CreateBrokerRequest.Builder |
brokerName(String brokerName)
Required.
|
CreateBrokerRequest.Builder |
configuration(ConfigurationId configuration)
A list of information about the configuration.
|
default CreateBrokerRequest.Builder |
configuration(Consumer<ConfigurationId.Builder> configuration)
A list of information about the configuration.
|
CreateBrokerRequest.Builder |
creatorRequestId(String creatorRequestId)
The unique ID that the requester receives for the created broker.
|
CreateBrokerRequest.Builder |
deploymentMode(DeploymentMode deploymentMode)
Required.
|
CreateBrokerRequest.Builder |
deploymentMode(String deploymentMode)
Required.
|
default CreateBrokerRequest.Builder |
encryptionOptions(Consumer<EncryptionOptions.Builder> encryptionOptions)
Encryption options for the broker.
|
CreateBrokerRequest.Builder |
encryptionOptions(EncryptionOptions encryptionOptions)
Encryption options for the broker.
|
CreateBrokerRequest.Builder |
engineType(EngineType engineType)
Required.
|
CreateBrokerRequest.Builder |
engineType(String engineType)
Required.
|
CreateBrokerRequest.Builder |
engineVersion(String engineVersion)
Required.
|
CreateBrokerRequest.Builder |
hostInstanceType(String hostInstanceType)
Required.
|
default CreateBrokerRequest.Builder |
ldapServerMetadata(Consumer<LdapServerMetadataInput.Builder> ldapServerMetadata)
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
|
CreateBrokerRequest.Builder |
ldapServerMetadata(LdapServerMetadataInput ldapServerMetadata)
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
|
default CreateBrokerRequest.Builder |
logs(Consumer<Logs.Builder> logs)
Enables Amazon CloudWatch logging for brokers.
|
CreateBrokerRequest.Builder |
logs(Logs logs)
Enables Amazon CloudWatch logging for brokers.
|
default CreateBrokerRequest.Builder |
maintenanceWindowStartTime(Consumer<WeeklyStartTime.Builder> maintenanceWindowStartTime)
The parameters that determine the WeeklyStartTime.
|
CreateBrokerRequest.Builder |
maintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
The parameters that determine the WeeklyStartTime.
|
CreateBrokerRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateBrokerRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateBrokerRequest.Builder |
publiclyAccessible(Boolean publiclyAccessible)
Required.
|
CreateBrokerRequest.Builder |
securityGroups(Collection<String> securityGroups)
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
|
CreateBrokerRequest.Builder |
securityGroups(String... securityGroups)
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
|
CreateBrokerRequest.Builder |
storageType(BrokerStorageType storageType)
The broker's storage type.
|
CreateBrokerRequest.Builder |
storageType(String storageType)
The broker's storage type.
|
CreateBrokerRequest.Builder |
subnetIds(Collection<String> subnetIds)
The list of groups that define which subnets and IP ranges the broker can use from different Availability
Zones.
|
CreateBrokerRequest.Builder |
subnetIds(String... subnetIds)
The list of groups that define which subnets and IP ranges the broker can use from different Availability
Zones.
|
CreateBrokerRequest.Builder |
tags(Map<String,String> tags)
Create tags when creating the broker.
|
CreateBrokerRequest.Builder |
users(Collection<User> users)
Required.
|
CreateBrokerRequest.Builder |
users(Consumer<User.Builder>... users)
Required.
|
CreateBrokerRequest.Builder |
users(User... users)
Required.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
CreateBrokerRequest.Builder authenticationStrategy(String authenticationStrategy)
authenticationStrategy
- The authentication strategy used to secure the broker.AuthenticationStrategy
,
AuthenticationStrategy
CreateBrokerRequest.Builder authenticationStrategy(AuthenticationStrategy authenticationStrategy)
authenticationStrategy
- The authentication strategy used to secure the broker.AuthenticationStrategy
,
AuthenticationStrategy
CreateBrokerRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
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.CreateBrokerRequest.Builder brokerName(String brokerName)
brokerName
- Required. 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.CreateBrokerRequest.Builder configuration(ConfigurationId configuration)
configuration
- A list of information about the configuration.default CreateBrokerRequest.Builder configuration(Consumer<ConfigurationId.Builder> configuration)
ConfigurationId.Builder
avoiding the need to create one manually via
ConfigurationId.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to configuration(ConfigurationId)
.configuration
- a consumer that will call methods on ConfigurationId.Builder
configuration(ConfigurationId)
CreateBrokerRequest.Builder creatorRequestId(String creatorRequestId)
creatorRequestId
- The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the
API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId.
You may omit the creatorRequestId if your application doesn't require idempotency.CreateBrokerRequest.Builder deploymentMode(String deploymentMode)
deploymentMode
- Required. The deployment mode of the broker.DeploymentMode
,
DeploymentMode
CreateBrokerRequest.Builder deploymentMode(DeploymentMode deploymentMode)
deploymentMode
- Required. The deployment mode of the broker.DeploymentMode
,
DeploymentMode
CreateBrokerRequest.Builder encryptionOptions(EncryptionOptions encryptionOptions)
encryptionOptions
- Encryption options for the broker.default CreateBrokerRequest.Builder encryptionOptions(Consumer<EncryptionOptions.Builder> encryptionOptions)
EncryptionOptions.Builder
avoiding the need to create one manually via
EncryptionOptions.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to encryptionOptions(EncryptionOptions)
.encryptionOptions
- a consumer that will call methods on EncryptionOptions.Builder
encryptionOptions(EncryptionOptions)
CreateBrokerRequest.Builder engineType(String engineType)
engineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.EngineType
,
EngineType
CreateBrokerRequest.Builder engineType(EngineType engineType)
engineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.EngineType
,
EngineType
CreateBrokerRequest.Builder engineVersion(String engineVersion)
engineVersion
- Required. The version of the broker engine. For a list of supported engine versions, see
https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.htmlCreateBrokerRequest.Builder hostInstanceType(String hostInstanceType)
hostInstanceType
- Required. The broker's instance type.CreateBrokerRequest.Builder ldapServerMetadata(LdapServerMetadataInput ldapServerMetadata)
ldapServerMetadata
- The metadata of the LDAP server used to authenticate and authorize connections to the broker.default CreateBrokerRequest.Builder ldapServerMetadata(Consumer<LdapServerMetadataInput.Builder> ldapServerMetadata)
LdapServerMetadataInput.Builder
avoiding the need to
create one manually via LdapServerMetadataInput.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to ldapServerMetadata(LdapServerMetadataInput)
.ldapServerMetadata
- a consumer that will call methods on LdapServerMetadataInput.Builder
ldapServerMetadata(LdapServerMetadataInput)
CreateBrokerRequest.Builder logs(Logs logs)
logs
- Enables Amazon CloudWatch logging for brokers.default CreateBrokerRequest.Builder logs(Consumer<Logs.Builder> logs)
Logs.Builder
avoiding the need to create one manually via Logs.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to logs(Logs)
.logs
- a consumer that will call methods on Logs.Builder
logs(Logs)
CreateBrokerRequest.Builder maintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
maintenanceWindowStartTime
- The parameters that determine the WeeklyStartTime.default CreateBrokerRequest.Builder maintenanceWindowStartTime(Consumer<WeeklyStartTime.Builder> maintenanceWindowStartTime)
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)
.maintenanceWindowStartTime
- a consumer that will call methods on WeeklyStartTime.Builder
maintenanceWindowStartTime(WeeklyStartTime)
CreateBrokerRequest.Builder publiclyAccessible(Boolean publiclyAccessible)
publiclyAccessible
- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.CreateBrokerRequest.Builder securityGroups(Collection<String> securityGroups)
securityGroups
- The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.CreateBrokerRequest.Builder securityGroups(String... securityGroups)
securityGroups
- The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.CreateBrokerRequest.Builder storageType(String storageType)
storageType
- The broker's storage type.BrokerStorageType
,
BrokerStorageType
CreateBrokerRequest.Builder storageType(BrokerStorageType storageType)
storageType
- The broker's storage type.BrokerStorageType
,
BrokerStorageType
CreateBrokerRequest.Builder subnetIds(Collection<String> subnetIds)
subnetIds
- The list of groups 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 (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ
deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment
without public accessibility requires at least one subnet.CreateBrokerRequest.Builder subnetIds(String... subnetIds)
subnetIds
- The list of groups 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 (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ
deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment
without public accessibility requires at least one subnet.CreateBrokerRequest.Builder tags(Map<String,String> tags)
tags
- Create tags when creating the broker.CreateBrokerRequest.Builder users(Collection<User> users)
users
- Required. The list of broker users (persons or applications) who can access queues and topics. For
RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first
provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers
or via the RabbitMQ Web Console. This value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters long.CreateBrokerRequest.Builder users(User... users)
users
- Required. The list of broker users (persons or applications) who can access queues and topics. For
RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first
provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers
or via the RabbitMQ Web Console. This value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters long.CreateBrokerRequest.Builder users(Consumer<User.Builder>... users)
List.Builder
avoiding the need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #users(List)
.users
- a consumer that will call methods on List.Builder
#users(List)
CreateBrokerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateBrokerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.