Class: Aws::RDS::Types::DescribeDBCapacityReservationsRequest

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeDBCapacityReservationsRequest

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_capacity_reservation_identifier ⇒ String

  The identifier or the name of the DB capacity reservation to describe.

• #filters ⇒ Array<Types::Filter>

  A filter that specifies which DB capacity reservations to describe.

• #marker ⇒ String

  An optional pagination token provided by a previous DescribeDBCapacityReservations request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

Instance Attribute Details

#db_capacity_reservation_identifier ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14137

class DescribeDBCapacityReservationsRequest < Struct.new(
  :db_capacity_reservation_identifier,
  :marker,
  :max_records,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

A filter that specifies which DB capacity reservations to describe.

Supported filters:

• db-capacity-reservation-name - Accepts DB capacity reservation names. The response includes only the reservations that these names identify. Use this filter to describe several reservations by name in one request.

• state - Accepts reservation states. The response includes only the reservations in these states.

• engine - Accepts database engine names. The response includes only the reservations that reserve capacity for these engines.

• db-instance-class - Accepts DB instance classes. The response includes only the reservations that reserve capacity for these DB instance classes.

• availability-zone - Accepts Availability Zone names. The response includes only the reservations that cover these Availability Zones.

When you specify more than one value for a filter, the response includes the reservations that match any of those values. When you specify more than one filter, the response includes only the reservations that match every filter.

Amazon RDS rejects the request when a filter name isn't in this list, or when a filter specifies no values.

The state filter doesn't accept expired. To find an expired reservation, compare EndDate against the current date and time.

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14137

class DescribeDBCapacityReservationsRequest < Struct.new(
  :db_capacity_reservation_identifier,
  :marker,
  :max_records,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#marker ⇒ String

An optional pagination token provided by a previous DescribeDBCapacityReservations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14137

class DescribeDBCapacityReservationsRequest < Struct.new(
  :db_capacity_reservation_identifier,
  :marker,
  :max_records,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#max_records ⇒ Integer

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints:

• Must be a minimum of 20.

• Can't exceed 100.

Returns:

• (Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14137

class DescribeDBCapacityReservationsRequest < Struct.new(
  :db_capacity_reservation_identifier,
  :marker,
  :max_records,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end