Interface PromoteReadReplicaRequest.Builder

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

  • Method Details

    • dbInstanceIdentifier

      PromoteReadReplicaRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

      The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing read replica DB instance.

      Example: mydbinstance

      Parameters:
      dbInstanceIdentifier - The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing read replica DB instance.

      Example: mydbinstance

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

    • backupRetentionPeriod

      PromoteReadReplicaRequest.Builder backupRetentionPeriod(Integer backupRetentionPeriod)

      The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Default: 1

      Constraints:

      • Must be a value from 0 to 35.

      • Can't be set to 0 if the DB instance is a source to read replicas.

      Parameters:
      backupRetentionPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Default: 1

      Constraints:

      • Must be a value from 0 to 35.

      • Can't be set to 0 if the DB instance is a source to read replicas.

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

    • preferredBackupWindow

      PromoteReadReplicaRequest.Builder preferredBackupWindow(String preferredBackupWindow)

      The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

      Parameters:
      preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

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

    • tagSpecifications

      PromoteReadReplicaRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      Tags to assign to resources associated with the DB instance.

      Valid Values:

      • auto-backup - The DB instance's automated backup.

      Parameters:
      tagSpecifications - Tags to assign to resources associated with the DB instance.

      Valid Values:

      • auto-backup - The DB instance's automated backup.

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

    • tagSpecifications

      PromoteReadReplicaRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      Tags to assign to resources associated with the DB instance.

      Valid Values:

      • auto-backup - The DB instance's automated backup.

      Parameters:
      tagSpecifications - Tags to assign to resources associated with the DB instance.

      Valid Values:

      • auto-backup - The DB instance's automated backup.

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

    • tagSpecifications

      PromoteReadReplicaRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      Tags to assign to resources associated with the DB instance.

      Valid Values:

      • auto-backup - The DB instance's automated backup.

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

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

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

    • overrideConfiguration

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

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