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

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 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,
  lease_id: "String",
  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 those reservations matching the specified DB instances class.

Returns:

  • (String)


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

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

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


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

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

#filtersArray<Types::Filter>

This parameter isn't currently supported.

Returns:



12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

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

#lease_idString

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

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

Returns:

  • (String)


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :lease_id,
  :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)


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :lease_id,
  :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)


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :lease_id,
  :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)


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :lease_id,
  :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)


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

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

#product_descriptionString

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

Returns:

  • (String)


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

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

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


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

class DescribeReservedDBInstancesMessage < Struct.new(
  :reserved_db_instance_id,
  :reserved_db_instances_offering_id,
  :db_instance_class,
  :duration,
  :product_description,
  :offering_type,
  :multi_az,
  :lease_id,
  :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 purchased reservations matching the specified offering identifier.

Returns:

  • (String)


12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 12988

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