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

Class: Aws::RDS::Types::DescribeOrderableDBInstanceOptionsMessage

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

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)


7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7059

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

#engineString

The name of the engine to retrieve DB instance options for.

Returns:

  • (String)


7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7059

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

#engine_versionString

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

Returns:

  • (String)


7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7059

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

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7059

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

#license_modelString

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

Returns:

  • (String)


7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7059

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

#markerString

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Returns:

  • (String)


7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7059

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

#max_recordsInteger

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

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)


7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7059

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

#vpcBoolean

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

Returns:

  • (Boolean)


7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7059

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