option_group_options

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

Overview

Name	option_group_options
Type	Resource
Id	aws.rds.option_group_options

Fields

The following fields are returned by SELECT queries:

describe_option_group_options

Name	Datatype	Description
copyable_cross_account	boolean	Indicates whether the option can be copied across Amazon Web Services accounts.
default_port	integer	If the option requires a port, specifies the default port for the option.
description	string	The description of the option.
engine_name	string	The name of the engine that this option can be applied to.
major_engine_version	string	Indicates the major engine version that the option is available for.
minimum_required_minor_engine_version	string	The minimum required engine version for the option to be applied.
name	string	The name of the option.
option_group_option_settings	string	The option settings that are available (and the default value) for each option in an option group.
option_group_option_versions	string	The versions that are available for the option.
options_conflicts_with	string	The options that conflict with this option.
options_depended_on	string	The options that are prerequisites for this option.
permanent	boolean	Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
persistent	boolean	Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
port_required	boolean	Indicates whether the option requires a port.
requires_auto_minor_engine_version_upgrade	boolean	If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
supports_option_version_downgrade	boolean	If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
vpc_only	boolean	If true, you can only use this option with a DB instance that is in a VPC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_option_group_options	select	EngineName, region	MajorEngineVersion, Filters, MaxRecords, Marker	Describes all available 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
EngineName	string	The name of the engine to describe options for. Valid Values: 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
region	string	AWS region (default: us-east-1)
Filters	array	This parameter isn't currently supported.
MajorEngineVersion	string	If specified, filters the results to include only options for the specified major engine version.
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 called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.

SELECT examples

describe_option_group_options

Describes all available options for the specified engine.

SELECT
copyable_cross_account,
default_port,
description,
engine_name,
major_engine_version,
minimum_required_minor_engine_version,
name,
option_group_option_settings,
option_group_option_versions,
options_conflicts_with,
options_depended_on,
permanent,
persistent,
port_required,
requires_auto_minor_engine_version_upgrade,
supports_option_version_downgrade,
vpc_only
FROM aws.rds.option_group_options
WHERE EngineName = '{{ EngineName }}' -- required
AND region = '{{ region }}' -- required
AND MajorEngineVersion = '{{ MajorEngineVersion }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;