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

Class: Aws::RDS::Types::DescribeReservedDBInstancesOfferingsMessage

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

Overview

Note:

When passing DescribeReservedDBInstancesOfferingsMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  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_class ⇒ String

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

Returns:

  • (String) —

    The DB instance class filter value.

#duration ⇒ String

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) —

    Duration filter value, specified in years or seconds.

#filters ⇒ Array<Types::Filter>

This parameter isn\'t currently supported.

Returns:

  • (Array<Types::Filter>) —

    This parameter isn\'t currently supported.

#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) —

    An optional pagination token provided by a previous request.

#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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer) —

    The maximum number of records to include in the response.

#multi_az ⇒ Boolean

A value that indicates whether to show only those reservations that support Multi-AZ.

Returns:

  • (Boolean) —

    A value that indicates whether to show only those reservations that support Multi-AZ.

#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) —

    The offering type filter value.

#product_description ⇒ String

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

The results show offerings that partially match the filter value.

Returns:

  • (String) —

    Product description filter value.

#reserved_db_instances_offering_id ⇒ String

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

Returns:

  • (String) —

    The offering identifier filter value.