orderable_db_instance_options

Creates, updates, deletes, gets or lists an orderable_db_instance_options resource.

Overview

Name	orderable_db_instance_options
Type	Resource
Id	aws.docdb.orderable_db_instance_options

Fields

The following fields are returned by SELECT queries:

describe_orderable_db_instance_options

Name	Datatype	Description
availability_zones	string	A list of Availability Zones for an instance.
db_instance_class	string	The instance class for an instance.
engine	string	The engine type of an instance.
engine_version	string	The engine version of an instance.
license_model	string	The license model for an instance.
storage_type	string	The storage type to associate with the DB cluster
vpc	boolean	Indicates whether an instance is in a virtual private cloud (VPC).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_orderable_db_instance_options	select	region	Engine, EngineVersion, DBInstanceClass, LicenseModel, Vpc, Filters, MaxRecords, Marker	Returns a list of orderable instance options for the specified engine.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
DBInstanceClass	string	The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.
Engine	string	The name of the engine to retrieve instance options for.
EngineVersion	string	The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.
Filters	array	This parameter is not currently supported.
LicenseModel	string	The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.
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.
MaxRecords	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.
Vpc	boolean	The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

SELECT examples

describe_orderable_db_instance_options

Returns a list of orderable instance options for the specified engine.

SELECT
availability_zones,
db_instance_class,
engine,
engine_version,
license_model,
storage_type,
vpc
FROM aws.docdb.orderable_db_instance_options
WHERE region = '{{ region }}' -- required
AND Engine = '{{ Engine }}'
AND EngineVersion = '{{ EngineVersion }}'
AND DBInstanceClass = '{{ DBInstanceClass }}'
AND LicenseModel = '{{ LicenseModel }}'
AND Vpc = '{{ Vpc }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;