You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeReservedDBInstancesMessage as input to an Aws::Client method, you can use a vanilla 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_classString

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

Returns:

  • (String)

    The DB instance class filter value.

#durationString

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)

    The duration filter value, specified in years or seconds.

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:

  • (Array<Types::Filter>)

    This parameter is not currently supported.

#markerString

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)

    An optional pagination token provided by a previous request.

#max_recordsInteger

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)

    The maximum number of records to include in the response.

#multi_azBoolean

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

Returns:

  • (Boolean)

    The Multi-AZ filter value.

#offering_typeString

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)

    The offering type filter value.

#product_descriptionString

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

Returns:

  • (String)

    The product description filter value.

#reserved_db_instance_idString

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

Returns:

  • (String)

    The reserved DB instance identifier filter value.

#reserved_db_instances_offering_idString

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

Returns:

  • (String)

    The offering identifier filter value.