Interface ModifyDbCapacityReservationRequest.Builder

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

  • Method Details

    • dbCapacityReservationIdentifier

      ModifyDbCapacityReservationRequest.Builder dbCapacityReservationIdentifier(String dbCapacityReservationIdentifier)

      The identifier or the name of the DB capacity reservation to modify. You can specify the identifier, which has the prefix dbcr-, or the reservation name.

      Parameters:
      dbCapacityReservationIdentifier - The identifier or the name of the DB capacity reservation to modify. You can specify the identifier, which has the prefix dbcr-, or the reservation name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityPerAvailabilityZone

      ModifyDbCapacityReservationRequest.Builder capacityPerAvailabilityZone(Integer capacityPerAvailabilityZone)

      The new number of DB instances to reserve in each Availability Zone of the reservation. Amazon RDS applies this number to every Availability Zone of the reservation.

      An increase reserves more capacity at the time of the request, so it can fail when the Amazon Web Services Region has insufficient capacity.

      This value multiplied by the number of Availability Zones counts against the DB instances quota for your Amazon Web Services account in the Amazon Web Services Region. Amazon RDS checks the quota only when you increase the value.

      Constraints:

      • Minimum 1.

      • Can't be less than the highest number of DB instances that use the reservation in any single Availability Zone of the reservation. That number includes a DB instance that holds a unit of reserved capacity for a pending modification. To find that number for an Availability Zone, subtract AvailableCapacity from ReservedCapacityPerAvailabilityZone.

      • During a capacity commitment, can't be less than CommittedCapacityPerAvailabilityZone.

      Parameters:
      capacityPerAvailabilityZone - The new number of DB instances to reserve in each Availability Zone of the reservation. Amazon RDS applies this number to every Availability Zone of the reservation.

      An increase reserves more capacity at the time of the request, so it can fail when the Amazon Web Services Region has insufficient capacity.

      This value multiplied by the number of Availability Zones counts against the DB instances quota for your Amazon Web Services account in the Amazon Web Services Region. Amazon RDS checks the quota only when you increase the value.

      Constraints:

      • Minimum 1.

      • Can't be less than the highest number of DB instances that use the reservation in any single Availability Zone of the reservation. That number includes a DB instance that holds a unit of reserved capacity for a pending modification. To find that number for an Availability Zone, subtract AvailableCapacity from ReservedCapacityPerAvailabilityZone.

      • During a capacity commitment, can't be less than CommittedCapacityPerAvailabilityZone.

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

    • endDateType

      ModifyDbCapacityReservationRequest.Builder endDateType(String endDateType)

      The end date type for the reservation.

      Valid Values:

      • limited - The reservation has a specific end date. You must also specify EndDate.

      • unlimited - The reservation doesn't expire. Don't specify EndDate.

      Parameters:
      endDateType - The end date type for the reservation.

      Valid Values:

      • limited - The reservation has a specific end date. You must also specify EndDate.

      • unlimited - The reservation doesn't expire. Don't specify EndDate.

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

    • endDateType

      ModifyDbCapacityReservationRequest.Builder endDateType(EndDateType endDateType)

      The end date type for the reservation.

      Valid Values:

      • limited - The reservation has a specific end date. You must also specify EndDate.

      • unlimited - The reservation doesn't expire. Don't specify EndDate.

      Parameters:
      endDateType - The end date type for the reservation.

      Valid Values:

      • limited - The reservation has a specific end date. You must also specify EndDate.

      • unlimited - The reservation doesn't expire. Don't specify EndDate.

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

    • endDate

      ModifyDbCapacityReservationRequest.Builder endDate(Instant endDate)

      The new end date for the reservation, in Universal Coordinated Time (UTC). Required when EndDateType is limited. Don't specify a value when EndDateType is unlimited.

      When you specify EndDate, you must also specify EndDateType.

      Constraints:

      • Must be a date and time in the future.

      • During a capacity commitment, must be at or after CommitmentEndDate.

      Parameters:
      endDate - The new end date for the reservation, in Universal Coordinated Time (UTC). Required when EndDateType is limited. Don't specify a value when EndDateType is unlimited.

      When you specify EndDate, you must also specify EndDateType.

      Constraints:

      • Must be a date and time in the future.

      • During a capacity commitment, must be at or after CommitmentEndDate.

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

    • overrideConfiguration

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

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