Interface CreateBrokerRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateBrokerRequest.Builder,
,CreateBrokerRequest> MqRequest.Builder
,SdkBuilder<CreateBrokerRequest.Builder,
,CreateBrokerRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateBrokerRequest
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationStrategy
(String authenticationStrategy) Optional.authenticationStrategy
(AuthenticationStrategy authenticationStrategy) Optional.autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.brokerName
(String brokerName) Required.default CreateBrokerRequest.Builder
configuration
(Consumer<ConfigurationId.Builder> configuration) A list of information about the configuration.configuration
(ConfigurationId configuration) A list of information about the configuration.creatorRequestId
(String creatorRequestId) The unique ID that the requester receives for the created broker.dataReplicationMode
(String dataReplicationMode) Defines whether this broker is a part of a data replication pair.dataReplicationMode
(DataReplicationMode dataReplicationMode) Defines whether this broker is a part of a data replication pair.dataReplicationPrimaryBrokerArn
(String dataReplicationPrimaryBrokerArn) The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker.deploymentMode
(String deploymentMode) Required.deploymentMode
(DeploymentMode deploymentMode) Required.default CreateBrokerRequest.Builder
encryptionOptions
(Consumer<EncryptionOptions.Builder> encryptionOptions) Encryption options for the broker.encryptionOptions
(EncryptionOptions encryptionOptions) Encryption options for the broker.engineType
(String engineType) Required.engineType
(EngineType engineType) Required.engineVersion
(String engineVersion) Required.hostInstanceType
(String hostInstanceType) Required.default CreateBrokerRequest.Builder
ldapServerMetadata
(Consumer<LdapServerMetadataInput.Builder> ldapServerMetadata) Optional.ldapServerMetadata
(LdapServerMetadataInput ldapServerMetadata) Optional.default CreateBrokerRequest.Builder
logs
(Consumer<Logs.Builder> logs) Enables Amazon CloudWatch logging for brokers.Enables Amazon CloudWatch logging for brokers.default CreateBrokerRequest.Builder
maintenanceWindowStartTime
(Consumer<WeeklyStartTime.Builder> maintenanceWindowStartTime) The parameters that determine the WeeklyStartTime.maintenanceWindowStartTime
(WeeklyStartTime maintenanceWindowStartTime) The parameters that determine the WeeklyStartTime.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.publiclyAccessible
(Boolean publiclyAccessible) Enables connections from applications outside of the VPC that hosts the broker's subnets.securityGroups
(String... securityGroups) The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.securityGroups
(Collection<String> securityGroups) The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.storageType
(String storageType) The broker's storage type.storageType
(BrokerStorageType storageType) The broker's storage type.The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.subnetIds
(Collection<String> subnetIds) The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.Create tags when creating the broker.users
(Collection<User> users) The list of broker users (persons or applications) who can access queues and topics.users
(Consumer<User.Builder>... users) The list of broker users (persons or applications) who can access queues and topics.The list of broker users (persons or applications) who can access queues and topics.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.mq.model.MqRequest.Builder
build
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
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
- Parameters:
authenticationStrategy
- Optional. 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.
- See Also:
-
authenticationStrategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
- Parameters:
authenticationStrategy
- Optional. 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.
- See Also:
-
autoMinorVersionUpgrade
Enables automatic upgrades to 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. Set to true by default, if no value is specified.
- Parameters:
autoMinorVersionUpgrade
- Enables automatic upgrades to 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. Set to true by default, if no value is specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
brokerName
Required. The broker's name. This value must be unique in your Amazon Web Services account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.
- Parameters:
brokerName
- Required. The broker's name. This value must be unique in your Amazon Web Services account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configuration
A list of information about the configuration.
- Parameters:
configuration
- A list of information about the configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configuration
A list of information about the configuration.
This is a convenience method that creates an instance of theConfigurationId.Builder
avoiding the need to create one manually viaConfigurationId.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfiguration(ConfigurationId)
.- Parameters:
configuration
- a consumer that will call methods onConfigurationId.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
creatorRequestId
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.
We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
- Parameters:
creatorRequestId
- The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deploymentMode
Required. The broker's deployment mode.
- Parameters:
deploymentMode
- Required. The broker's deployment mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deploymentMode
Required. The broker's deployment mode.
- Parameters:
deploymentMode
- Required. The broker's deployment mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encryptionOptions
Encryption options for the broker.
- Parameters:
encryptionOptions
- Encryption options for the broker.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionOptions
default CreateBrokerRequest.Builder encryptionOptions(Consumer<EncryptionOptions.Builder> encryptionOptions) Encryption options for the broker.
This is a convenience method that creates an instance of theEncryptionOptions.Builder
avoiding the need to create one manually viaEncryptionOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionOptions(EncryptionOptions)
.- Parameters:
encryptionOptions
- a consumer that will call methods onEncryptionOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
engineType
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
- Parameters:
engineType
- Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
engineType
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
- Parameters:
engineType
- Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
engineVersion
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
- Parameters:
engineVersion
- Required. The broker engine's version. For a list of supported engine versions, see Supported engines.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hostInstanceType
Required. The broker's instance type.
- Parameters:
hostInstanceType
- Required. The broker's instance type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ldapServerMetadata
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- Parameters:
ldapServerMetadata
- Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ldapServerMetadata
default CreateBrokerRequest.Builder ldapServerMetadata(Consumer<LdapServerMetadataInput.Builder> ldapServerMetadata) Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
This is a convenience method that creates an instance of theLdapServerMetadataInput.Builder
avoiding the need to create one manually viaLdapServerMetadataInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toldapServerMetadata(LdapServerMetadataInput)
.- Parameters:
ldapServerMetadata
- a consumer that will call methods onLdapServerMetadataInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logs
Enables Amazon CloudWatch logging for brokers.
- Parameters:
logs
- Enables Amazon CloudWatch logging for brokers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logs
Enables Amazon CloudWatch logging for brokers.
This is a convenience method that creates an instance of theLogs.Builder
avoiding the need to create one manually viaLogs.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologs(Logs)
.- Parameters:
logs
- a consumer that will call methods onLogs.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 CreateBrokerRequest.Builder maintenanceWindowStartTime(Consumer<WeeklyStartTime.Builder> maintenanceWindowStartTime) The parameters that determine the WeeklyStartTime.
This is a convenience method that creates an instance of theWeeklyStartTime.Builder
avoiding the need to create one manually viaWeeklyStartTime.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomaintenanceWindowStartTime(WeeklyStartTime)
.- Parameters:
maintenanceWindowStartTime
- a consumer that will call methods onWeeklyStartTime.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
publiclyAccessible
Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
- Parameters:
publiclyAccessible
- Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- Parameters:
securityGroups
- 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
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- Parameters:
securityGroups
- 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.
-
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.
- See Also:
-
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.
- See Also:
-
subnetIds
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
- Parameters:
subnetIds
- The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
- Parameters:
subnetIds
- The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Create tags when creating the broker.
- Parameters:
tags
- Create tags when creating the broker.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
users
The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ 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.
- Parameters:
users
- The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
users
The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ 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.
- Parameters:
users
- The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
users
The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ 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 is a convenience method that creates an instance of theUser.Builder
avoiding the need to create one manually viaUser.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tousers(List<User>)
.- Parameters:
users
- a consumer that will call methods onUser.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataReplicationMode
Defines whether this broker is a part of a data replication pair.
- Parameters:
dataReplicationMode
- Defines whether this broker is a part of a data replication pair.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataReplicationMode
Defines whether this broker is a part of a data replication pair.
- Parameters:
dataReplicationMode
- Defines whether this broker is a part of a data replication pair.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataReplicationPrimaryBrokerArn
The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.
- Parameters:
dataReplicationPrimaryBrokerArn
- The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateBrokerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateBrokerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-