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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

Constant Summary collapse

SENSITIVE =
[]

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)

12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

class DescribeReservedDBInstancesOfferingsMessage < Struct.new(
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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)

12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

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

#filtersArray<Types::Filter>

This parameter isn't currently supported.

Returns:


12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

class DescribeReservedDBInstancesOfferingsMessage < Struct.new(
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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)

12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

class DescribeReservedDBInstancesOfferingsMessage < Struct.new(
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)

12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

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

#multi_azBoolean

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

Returns:

  • (Boolean)

12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

class DescribeReservedDBInstancesOfferingsMessage < Struct.new(
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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)

12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

class DescribeReservedDBInstancesOfferingsMessage < Struct.new(
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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.

<note markdown=“1”> The results show offerings that partially match the filter value.

</note>

Returns:

  • (String)

12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

class DescribeReservedDBInstancesOfferingsMessage < Struct.new(
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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)

12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
# File 'lib/aws-sdk-rds/types.rb', line 12933

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