Class: Aws::RDS::Types::DescribeReservedDBInstancesMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeReservedDBInstancesMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass DescribeReservedDBInstancesMessage data as a hash:

{
  reserved_db_instance_id: "String",
  reserved_db_instances_offering_id: "String",
  db_instance_class: "String",
  duration: "String",
  product_description: "String",
  offering_type: "String",
  multi_az: false,
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #db_instance_class ⇒ String

  The DB instance class filter value.

• #duration ⇒ String

  The duration filter value, specified in years or seconds.

• #filters ⇒ Array<Types::Filter>

  This parameter is not currently supported.

• #marker ⇒ String

  An optional pagination token provided by a previous request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

• #multi_az ⇒ Boolean

  The Multi-AZ filter value.

• #offering_type ⇒ String

  The offering type filter value.

• #product_description ⇒ String

  The product description filter value.

• #reserved_db_instance_id ⇒ String

  The reserved DB instance identifier filter value.

• #reserved_db_instances_offering_id ⇒ String

  The offering identifier filter value.

Instance Attribute Details

#db_instance_class ⇒ String

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Returns:

• (String)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#duration ⇒ String

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: ‘1 | 3 | 31536000 | 94608000`

Returns:

• (String)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:

• (Array<Types::Filter>)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#marker ⇒ String

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

Returns:

• (String)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#max_records ⇒ Integer

The maximum number of records to include in the response. If more than the ‘MaxRecords` value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

• (Integer)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#multi_az ⇒ Boolean

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

Returns:

• (Boolean)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#offering_type ⇒ String

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: ‘“Partial Upfront” | “All Upfront” | “No Upfront” `

Returns:

• (String)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#product_description ⇒ String

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

Returns:

• (String)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#reserved_db_instance_id ⇒ String

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

Returns:

• (String)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#reserved_db_instances_offering_id ⇒ String

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Returns:

• (String)

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

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end