Interface StartDbInstanceRequest.Builder

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

  • Method Details

    • dbInstanceIdentifier

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

    • dbCapacityReservationIdentifier

      StartDbInstanceRequest.Builder dbCapacityReservationIdentifier(String dbCapacityReservationIdentifier)

      The identifier or the name of the DB capacity reservation for the DB instance to use after it starts. You can specify the identifier, which has the prefix dbcr-, or the reservation name.

      Specify this parameter when the DB instance stopped using a reservation, or when you want the DB instance to use a different reservation.

      If you omit this parameter, and the DB instance kept a DB capacity reservation when it stopped, Amazon RDS starts the DB instance in that reservation.

      If that reservation is deleted, ended, or cancelled, the DB instance still starts. Amazon RDS starts the DB instance outside the reservation, on unreserved capacity, and it charges on-demand prices for the DB instance.

      If that reservation has no available capacity in the Availability Zone of the DB instance, the request fails. Amazon RDS doesn't start the DB instance, and it doesn't wait for capacity in that Availability Zone. Specify a reservation that has available capacity in that Availability Zone, or retry the request after the reservation has available capacity.

      Constraints:

      • The reservation must be in the active state.

      • The reservation must reserve capacity for the DB instance class and the engine of the DB instance.

      • The reservation must cover the Availability Zone of the DB instance, and it must have available capacity in that Availability Zone.

      Parameters:
      dbCapacityReservationIdentifier - The identifier or the name of the DB capacity reservation for the DB instance to use after it starts. You can specify the identifier, which has the prefix dbcr-, or the reservation name.

      Specify this parameter when the DB instance stopped using a reservation, or when you want the DB instance to use a different reservation.

      If you omit this parameter, and the DB instance kept a DB capacity reservation when it stopped, Amazon RDS starts the DB instance in that reservation.

      If that reservation is deleted, ended, or cancelled, the DB instance still starts. Amazon RDS starts the DB instance outside the reservation, on unreserved capacity, and it charges on-demand prices for the DB instance.

      If that reservation has no available capacity in the Availability Zone of the DB instance, the request fails. Amazon RDS doesn't start the DB instance, and it doesn't wait for capacity in that Availability Zone. Specify a reservation that has available capacity in that Availability Zone, or retry the request after the reservation has available capacity.

      Constraints:

      • The reservation must be in the active state.

      • The reservation must reserve capacity for the DB instance class and the engine of the DB instance.

      • The reservation must cover the Availability Zone of the DB instance, and it must have available capacity in that Availability Zone.

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

    • overrideConfiguration

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

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