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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeOrderableDBInstanceOptionsMessage

Includes:

Structure

Defined in:

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",
  availability_zone_group: "String",
  vpc: false,
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zone_group ⇒ String

  The Availability Zone group associated with a Local Zone.

• #db_instance_class ⇒ String

  The DB instance class filter value.

• #engine ⇒ String

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

• #engine_version ⇒ String

  The engine version filter value.

• #filters ⇒ Array<Types::Filter>

  This parameter isn't currently supported.

• #license_model ⇒ String

  The license model filter value.

• #marker ⇒ String

  An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

• #vpc ⇒ Boolean

  A value that indicates whether to show only VPC or non-VPC offerings.

Instance Attribute Details

#availability_zone_group ⇒ String

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

Returns:

• (String)

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

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

#db_instance_class ⇒ String

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

Returns:

• (String)

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

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

#engine ⇒ String

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

Valid Values:

• `aurora` (for MySQL 5.6-compatible Aurora)

• `aurora-mysql` (for MySQL 5.7-compatible Aurora)

• `aurora-postgresql`

• `mariadb`

• `mysql`

• `oracle-ee`

• `oracle-ee-cdb`

• `oracle-se2`

• `oracle-se2-cdb`

• `postgres`

• `sqlserver-ee`

• `sqlserver-se`

• `sqlserver-ex`

• `sqlserver-web`

Returns:

• (String)

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

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :availability_zone_group,
  :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 matching the specified engine version.

Returns:

• (String)

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

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

#filters ⇒ Array<Types::Filter>

This parameter isn't currently supported.

Returns:

• (Array<Types::Filter>)

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

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :availability_zone_group,
  :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 matching the specified license model.

Returns:

• (String)

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

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

#marker ⇒ String

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)

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

class DescribeOrderableDBInstanceOptionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_instance_class,
  :license_model,
  :availability_zone_group,
  :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 called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

• (Integer)

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

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

#vpc ⇒ Boolean

A value that indicates whether to show only VPC or non-VPC offerings.

Returns:

• (Boolean)

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

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