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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeReservedDBInstancesMessage

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",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_instance_class ⇒ String

  The DB instance class filter value.

• #duration ⇒ String

  The duration filter value, specified in years or seconds.

• #filters ⇒ Array<Types::Filter>

  This parameter isn't currently supported.

• #lease_id ⇒ String

  The lease identifier filter value.

• #marker ⇒ String

  An optional pagination token provided by a previous request.

• #max_records ⇒ 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.

• #offering_type ⇒ String

  The offering type filter value.

• #product_description ⇒ String

  The product description filter value.

• #reserved_db_instance_id ⇒ String

  The reserved DB instance identifier filter value.

• #reserved_db_instances_offering_id ⇒ String

  The offering identifier filter value.

Instance Attribute Details

#db_instance_class ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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

#duration ⇒ String

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)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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

#filters ⇒ Array<Types::Filter>

This parameter isn't currently supported.

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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_id ⇒ String

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)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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

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

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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_az ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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_description ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 13046

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