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.neptune.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 a DB instance.
db_instance_class	string	The DB instance class for a DB instance.
engine	string	The engine type of a DB instance.
engine_version	string	The engine version of a DB instance.
license_model	string	The license model for a DB instance.
max_iops_per_db_instance	integer	Maximum total provisioned IOPS for a DB instance.
max_iops_per_gib	number	Maximum provisioned IOPS per GiB for a DB instance.
max_storage_size	integer	Maximum storage size for a DB instance.
min_iops_per_db_instance	integer	Minimum total provisioned IOPS for a DB instance.
min_iops_per_gib	number	Minimum provisioned IOPS per GiB for a DB instance.
min_storage_size	integer	Minimum storage size for a DB instance.
multi_az_capable	boolean	Indicates whether a DB instance is Multi-AZ capable.
read_replica_capable	boolean	Indicates whether a DB instance can have a Read Replica.
storage_type	string	Not applicable. In Neptune the storage type is managed at the DB Cluster level.
supported_network_types	string	The network types supported by the orderable DB instance option.
supports_enhanced_monitoring	boolean	Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
supports_global_databases	boolean	A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes.
supports_iam_database_authentication	boolean	Indicates whether a DB instance supports IAM database authentication.
supports_iops	boolean	Indicates whether a DB instance supports provisioned IOPS.
supports_performance_insights	boolean	(Not supported by Neptune)
supports_storage_encryption	boolean	Indicates whether a DB instance supports encrypted storage.
vpc	boolean	Indicates whether a DB instance is in a 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 DB 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 DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
Engine	string	The name of the engine to retrieve DB instance options for.
EngineVersion	string	The engine version filter value. Specify this parameter to show only the available offerings matching 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 matching the specified license model.
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 .
MaxRecords	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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
Vpc	boolean	The 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 DB instance options for the specified engine.

SELECT
availability_zones,
db_instance_class,
engine,
engine_version,
license_model,
max_iops_per_db_instance,
max_iops_per_gib,
max_storage_size,
min_iops_per_db_instance,
min_iops_per_gib,
min_storage_size,
multi_az_capable,
read_replica_capable,
storage_type,
supported_network_types,
supports_enhanced_monitoring,
supports_global_databases,
supports_iam_database_authentication,
supports_iops,
supports_performance_insights,
supports_storage_encryption,
vpc
FROM aws.neptune.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 }}'
;