Interface UpdateBrokerRequest.Builder

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

  • Method Details

    • authenticationStrategy

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

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

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

      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.

      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.

    • brokerId

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

    • configuration

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

    • engineVersion

      UpdateBrokerRequest.Builder engineVersion(String engineVersion)

      The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

      When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

      Parameters:
      engineVersion - The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

      When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

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

    • hostInstanceType

      UpdateBrokerRequest.Builder hostInstanceType(String hostInstanceType)

      The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

      Parameters:
      hostInstanceType - The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ldapServerMetadata

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

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

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

    • securityGroups

      UpdateBrokerRequest.Builder securityGroups(Collection<String> securityGroups)

      The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

      Parameters:
      securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroups

      UpdateBrokerRequest.Builder securityGroups(String... securityGroups)

      The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

      Parameters:
      securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataReplicationMode

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

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

    • overrideConfiguration

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

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