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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone_groupString

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 AWS Region.

Returns:

  • (String)


10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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_classString

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

Returns:

  • (String)


10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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

#engineString

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

Returns:

  • (String)


10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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_versionString

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

Returns:

  • (String)


10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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

#filtersArray<Types::Filter>

This parameter isn't currently supported.

Returns:



10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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_modelString

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

Returns:

  • (String)


10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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

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


10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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_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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)


10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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

#vpcBoolean

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

Returns:

  • (Boolean)


10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10855

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