Class: Aws::DocDB::Types::DescribeOrderableDBInstanceOptionsMessage

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::DescribeOrderableDBInstanceOptionsMessage

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/types.rb

Overview

Note:

When making an API call, you may pass DescribeOrderableDBInstanceOptionsMessage data as a hash:

{
  engine: "String", # required
  engine_version: "String",
  db_instance_class: "String",
  license_model: "String",
  vpc: false,
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

Represents the input to DescribeOrderableDBInstanceOptions.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_instance_class ⇒ String

  The instance class filter value.

• #engine ⇒ String

  The name of the engine to retrieve instance options for.

• #engine_version ⇒ String

  The engine version filter value.

• #filters ⇒ Array<Types::Filter>

  This parameter is not currently supported.

• #license_model ⇒ String

  The license model 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.

• #vpc ⇒ Boolean

  The virtual private cloud (VPC) filter value.

Instance Attribute Details

#db_instance_class ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3645

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :vpc,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

The name of the engine to retrieve instance options for.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3645

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :vpc,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3645

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :vpc,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-docdb/types.rb', line 3645

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :vpc,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#license_model ⇒ String

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 3645

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :vpc,
  :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 'lib/aws-sdk-docdb/types.rb', line 3645

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :vpc,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#max_records ⇒ Integer

The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

• (Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 3645

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :vpc,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#vpc ⇒ Boolean

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 3645

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :vpc,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end