Class: Aws::RDS::Types::ModifyDBCapacityReservationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_per_availability_zone ⇒ Integer

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:

  • (Integer)


19524
19525
19526
19527
19528
19529
19530
19531
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19524

class ModifyDBCapacityReservationRequest < Struct.new(
  :db_capacity_reservation_identifier,
  :capacity_per_availability_zone,
  :end_date_type,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end

#db_capacity_reservation_identifier ⇒ String

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:

  • (String)


19524
19525
19526
19527
19528
19529
19530
19531
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19524

class ModifyDBCapacityReservationRequest < Struct.new(
  :db_capacity_reservation_identifier,
  :capacity_per_availability_zone,
  :end_date_type,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end

#end_date ⇒ Time

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:

  • (Time)


19524
19525
19526
19527
19528
19529
19530
19531
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19524

class ModifyDBCapacityReservationRequest < Struct.new(
  :db_capacity_reservation_identifier,
  :capacity_per_availability_zone,
  :end_date_type,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end

#end_date_type ⇒ String

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:

  • (String)


19524
19525
19526
19527
19528
19529
19530
19531
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 19524

class ModifyDBCapacityReservationRequest < Struct.new(
  :db_capacity_reservation_identifier,
  :capacity_per_availability_zone,
  :end_date_type,
  :end_date)
  SENSITIVE = []
  include Aws::Structure
end