Skip to content

aws.rds.describe_option_group_options

Example SQL Queries

SELECT * FROM
aws.rds.describe_option_group_options
WHERE
"engine_name" = 'VALUE';

Description

Describes all available options for the specified engine.

Table Definition

Column NameColumn Data Type
engine_name Required Input Column

The name of the engine that this option can be applied to.

VARCHAR
filters Input Column

This parameter isn't currently supported.

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case-sensitive.

filters[].values[]
major_engine_version Input Column

Indicates the major engine version that the option is available for.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
copyable_cross_account

Indicates whether the option can be copied across Amazon Web Services accounts.

BOOLEAN
default_port

If the option requires a port, specifies the default port for the option.

BIGINT
description

The description of the option.

VARCHAR
minimum_required_minor_engine_version

The minimum required engine version for the option to be applied.

VARCHAR
name

The name of the option.

VARCHAR
option_group_option_settings

The option settings that are available (and the default value) for each option in an option group.

STRUCT(
"setting_name" VARCHAR,
"setting_description" VARCHAR,
"default_value" VARCHAR,
"apply_type" VARCHAR,
"allowed_values" VARCHAR,
"is_modifiable" BOOLEAN,
"is_required" BOOLEAN,
"minimum_engine_version_per_allowed_value" STRUCT(
"allowed_value" VARCHAR,
"minimum_engine_version" VARCHAR
)[]
)[]
Show child fields
option_group_option_settings[]
Show child fields
option_group_option_settings[].allowed_values

Indicates the acceptable values for the option group option.

option_group_option_settings[].apply_type

The DB engine specific parameter type for the option group option.

option_group_option_settings[].default_value

The default value for the option group option.

option_group_option_settings[].is_modifiable

Indicates whether this option group option can be changed from the default value.

option_group_option_settings[].is_required

Indicates whether a value must be specified for this option setting of the option group option.

option_group_option_settings[].minimum_engine_version_per_allowed_value[]
Show child fields
option_group_option_settings[].minimum_engine_version_per_allowed_value[].allowed_value

The allowed value for an option setting.

option_group_option_settings[].minimum_engine_version_per_allowed_value[].minimum_engine_version

The minimum DB engine version required for the allowed value.

option_group_option_settings[].setting_description

The description of the option group option.

option_group_option_settings[].setting_name

The name of the option group option.

option_group_option_versions

The versions that are available for the option.

STRUCT(
"version" VARCHAR,
"is_default" BOOLEAN
)[]
Show child fields
option_group_option_versions[]
Show child fields
option_group_option_versions[].is_default

Indicates whether the version is the default version of the option.

option_group_option_versions[].version

The version of the option.

options_conflicts_with

The options that conflict with this option.

VARCHAR[]
Show child fields
options_conflicts_with[]
options_depended_on

The options that are prerequisites for this option.

VARCHAR[]
Show child fields
options_depended_on[]
permanent

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.

BOOLEAN
persistent

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.

BOOLEAN
port_required

Indicates whether the option requires a port.

BOOLEAN
requires_auto_minor_engine_version_upgrade

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.

BOOLEAN
supports_option_version_downgrade

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

BOOLEAN
vpc_only

If true, you can only use this option with a DB instance that is in a VPC.

BOOLEAN