Interface StopDbInstanceRequest.Builder

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

  • Method Details

    • dbInstanceIdentifier

      StopDbInstanceRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

      The user-supplied instance identifier.

      Parameters:
      dbInstanceIdentifier - The user-supplied instance identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbSnapshotIdentifier

      StopDbInstanceRequest.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier)

      The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

      Parameters:
      dbSnapshotIdentifier - The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • detachFromDBCapacityReservation

      StopDbInstanceRequest.Builder detachFromDBCapacityReservation(Boolean detachFromDBCapacityReservation)

      Specifies whether the DB instance stops using its DB capacity reservation when the DB instance stops. When you specify true, the DB instance belongs to no reservation after it stops, and a later start launches it outside the reservation.

      By default, a stopped DB instance keeps its DB capacity reservation, and a later start returns the DB instance to the same reservation.

      Every stop releases the unit of reserved capacity that the DB instance holds, for either value of this parameter. Another DB instance can then use that capacity. This parameter controls the reservation that the DB instance belongs to, and it does not control the release of the capacity.

      If the DB instance uses no DB capacity reservation, this parameter has no effect.

      Amazon RDS holds no capacity for a stopped DB instance. When the reservation has no available capacity in the Availability Zone of the DB instance, a later start waits for capacity in that Availability Zone. When the DB instance belongs to no reservation, a later start can fail because the Amazon Web Services Region has insufficient capacity for the DB instance class.

      Parameters:
      detachFromDBCapacityReservation - Specifies whether the DB instance stops using its DB capacity reservation when the DB instance stops. When you specify true, the DB instance belongs to no reservation after it stops, and a later start launches it outside the reservation.

      By default, a stopped DB instance keeps its DB capacity reservation, and a later start returns the DB instance to the same reservation.

      Every stop releases the unit of reserved capacity that the DB instance holds, for either value of this parameter. Another DB instance can then use that capacity. This parameter controls the reservation that the DB instance belongs to, and it does not control the release of the capacity.

      If the DB instance uses no DB capacity reservation, this parameter has no effect.

      Amazon RDS holds no capacity for a stopped DB instance. When the reservation has no available capacity in the Availability Zone of the DB instance, a later start waits for capacity in that Availability Zone. When the DB instance belongs to no reservation, a later start can fail because the Amazon Web Services Region has insufficient capacity for the DB instance class.

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

    • overrideConfiguration

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

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