Interface CreateBrokerRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>, MqRequest.Builder, SdkBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateBrokerRequest
@Mutable @NotThreadSafe public static interface CreateBrokerRequest.Builder extends MqRequest.Builder, SdkPojo, CopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>

  • Method Details

    • authenticationStrategy

      CreateBrokerRequest.Builder authenticationStrategy(String 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

      CreateBrokerRequest.Builder authenticationStrategy(AuthenticationStrategy 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

      CreateBrokerRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

      Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to true by default, if no value is specified.

      Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

      Parameters:
      autoMinorVersionUpgrade - Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to true by default, if no value is specified.

      Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

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

    • brokerName

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

      CreateBrokerRequest.Builder configuration(ConfigurationId 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

      default CreateBrokerRequest.Builder configuration(Consumer<ConfigurationId.Builder> configuration)

      A list of information about the configuration.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      configuration - a consumer that will call methods on ConfigurationId.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creatorRequestId

      CreateBrokerRequest.Builder creatorRequestId(String 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

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

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

      CreateBrokerRequest.Builder encryptionOptions(EncryptionOptions 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 the 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).

      Parameters:
      encryptionOptions - a consumer that will call methods on EncryptionOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • engineType

      CreateBrokerRequest.Builder engineType(String 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

      CreateBrokerRequest.Builder engineType(EngineType 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

      CreateBrokerRequest.Builder engineVersion(String engineVersion)

      The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

      Parameters:
      engineVersion - The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostInstanceType

      CreateBrokerRequest.Builder hostInstanceType(String 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

      CreateBrokerRequest.Builder ldapServerMetadata(LdapServerMetadataInput 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 the 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).

      Parameters:
      ldapServerMetadata - a consumer that will call methods on LdapServerMetadataInput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logs

      CreateBrokerRequest.Builder logs(Logs 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

      default CreateBrokerRequest.Builder logs(Consumer<Logs.Builder> logs)

      Enables Amazon CloudWatch logging for brokers.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      logs - a consumer that will call methods on Logs.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maintenanceWindowStartTime

      CreateBrokerRequest.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 CreateBrokerRequest.Builder maintenanceWindowStartTime(Consumer<WeeklyStartTime.Builder> maintenanceWindowStartTime)

      The parameters that determine the WeeklyStartTime.

      This is a convenience method 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:

    • publiclyAccessible

      CreateBrokerRequest.Builder publiclyAccessible(Boolean 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

      CreateBrokerRequest.Builder securityGroups(Collection<String> 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

      CreateBrokerRequest.Builder securityGroups(String... 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

      CreateBrokerRequest.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.
      See Also:

    • storageType

      CreateBrokerRequest.Builder storageType(BrokerStorageType 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

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

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

      CreateBrokerRequest.Builder tags(Map<String,String> 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

      CreateBrokerRequest.Builder users(Collection<User> 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

      CreateBrokerRequest.Builder users(User... 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

      CreateBrokerRequest.Builder users(Consumer<User.Builder>... 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 the User.Builder avoiding the need to create one manually via User.builder().

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

      Parameters:
      users - a consumer that will call methods on User.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataReplicationMode

      CreateBrokerRequest.Builder dataReplicationMode(String 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

      CreateBrokerRequest.Builder dataReplicationMode(DataReplicationMode 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

      CreateBrokerRequest.Builder 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. 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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.