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

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

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

Overview

Note:

When making an API call, you may pass DescribeReservedDBInstancesOfferingsMessage data as a 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_classString

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

Returns:

  • (String)


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

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

#durationString

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)


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

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

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

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

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


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

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

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


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

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

#multi_azBoolean

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

Returns:

  • (Boolean)


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

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

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


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

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

#product_descriptionString

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)


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

class DescribeReservedDBInstancesOfferingsMessage < Struct.new(
  :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_idString

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)


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7816

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