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.rds.orderable_db_instance_options

Fields

The following fields are returned by SELECT queries:

describe_orderable_db_instance_options

Name	Datatype	Description
availability_zone_group	string	The Availability Zone group for a DB instance.
availability_zones	string	A list of Availability Zones for a DB instance.
available_additional_storage_volumes_options	string	The available options for additional storage volumes for the DB instance class.
available_processor_features	string	A list of the available processor features for the DB instance class of 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.
max_storage_throughput_per_db_instance	integer	Maximum storage throughput for a DB instance.
max_storage_throughput_per_iops	number	Maximum storage throughput to provisioned IOPS ratio 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.
min_storage_throughput_per_db_instance	integer	Minimum storage throughput for a DB instance.
min_storage_throughput_per_iops	number	Minimum storage throughput to provisioned IOPS ratio for a DB instance.
multi_az_capable	boolean	Indicates whether a DB instance is Multi-AZ capable.
outpost_capable	boolean	Indicates whether a DB instance supports RDS on Outposts. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
read_replica_capable	boolean	Indicates whether a DB instance can have a read replica.
storage_type	string	The storage type for a DB instance.
supported_activity_stream_modes	string	The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.
supported_engine_modes	string	A list of the supported DB engine modes.
supported_network_types	string	The network types supported by the DB instance (IPV4 or DUAL). A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
supports_additional_storage_volumes	boolean	Indicates whether the DB instance class supports additional storage volumes.
supports_clusters	boolean	Indicates whether DB instances can be configured as a Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
supports_dedicated_log_volume	boolean	Indicates whether a DB instance supports using a dedicated log volume (DLV).
supports_enhanced_monitoring	boolean	Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
supports_global_databases	boolean	Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
supports_http_endpoint	boolean	Indicates whether a DB instance supports HTTP endpoints.
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_kerberos_authentication	boolean	Indicates whether a DB instance supports Kerberos Authentication.
supports_performance_insights	boolean	Indicates whether a DB instance supports Performance Insights.
supports_storage_autoscaling	boolean	Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
supports_storage_encryption	boolean	Indicates whether a DB instance supports encrypted storage.
supports_storage_throughput	boolean	Indicates whether a DB instance supports storage throughput.
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, AvailabilityZoneGroup, Vpc, Filters, MaxRecords, Marker	Describes the orderable DB instance options for a specified DB 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)
AvailabilityZoneGroup	string	The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group. Omit this parameter to show the available options in the specified Amazon Web Services Region. This setting doesn't apply to RDS Custom DB instances.
DBInstanceClass	string	A filter to include only the available options for the specified DB instance class.
Engine	string	The name of the database engine to describe DB instance options for. Valid Values: aurora-mysql aurora-postgresql custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb db2-ae db2-ce db2-se mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
EngineVersion	string	A filter to include only the available options for the specified engine version.
Filters	array	This parameter isn't currently supported.
LicenseModel	string	A filter to include only the available options for the specified license model. RDS Custom supports only the BYOL licensing 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 you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 1000.
Vpc	boolean	Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings. RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

SELECT examples

describe_orderable_db_instance_options

Describes the orderable DB instance options for a specified DB engine.

SELECT
availability_zone_group,
availability_zones,
available_additional_storage_volumes_options,
available_processor_features,
db_instance_class,
engine,
engine_version,
license_model,
max_iops_per_db_instance,
max_iops_per_gib,
max_storage_size,
max_storage_throughput_per_db_instance,
max_storage_throughput_per_iops,
min_iops_per_db_instance,
min_iops_per_gib,
min_storage_size,
min_storage_throughput_per_db_instance,
min_storage_throughput_per_iops,
multi_az_capable,
outpost_capable,
read_replica_capable,
storage_type,
supported_activity_stream_modes,
supported_engine_modes,
supported_network_types,
supports_additional_storage_volumes,
supports_clusters,
supports_dedicated_log_volume,
supports_enhanced_monitoring,
supports_global_databases,
supports_http_endpoint,
supports_iam_database_authentication,
supports_iops,
supports_kerberos_authentication,
supports_performance_insights,
supports_storage_autoscaling,
supports_storage_encryption,
supports_storage_throughput,
vpc
FROM aws.rds.orderable_db_instance_options
WHERE region = '{{ region }}' -- required
AND Engine = '{{ Engine }}'
AND EngineVersion = '{{ EngineVersion }}'
AND DBInstanceClass = '{{ DBInstanceClass }}'
AND LicenseModel = '{{ LicenseModel }}'
AND AvailabilityZoneGroup = '{{ AvailabilityZoneGroup }}'
AND Vpc = '{{ Vpc }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;