Skip to content

aws.rds.describe_option_groups

Example SQL Queries

SELECT * FROM
aws.rds.describe_option_groups;

Description

Describes the available option groups.

Table Definition

Column NameColumn Data Type
engine_name Input Column

Indicates the name of the engine that this option group 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 associated with this option group.

VARCHAR
option_group_name Input Column

Specifies the name of the option group.

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
allows_vpc_and_non_vpc_instance_memberships

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

BOOLEAN
copy_timestamp

Indicates when the option group was copied.

TIMESTAMP_S
option_group_arn

Specifies the Amazon Resource Name (ARN) for the option group.

VARCHAR
option_group_description

Provides a description of the option group.

VARCHAR
options

Indicates what options are available in the option group.

STRUCT(
"option_name" VARCHAR,
"option_description" VARCHAR,
"persistent" BOOLEAN,
"permanent" BOOLEAN,
"port" BIGINT,
"option_version" VARCHAR,
"option_settings" STRUCT(
"name" VARCHAR,
"value" VARCHAR,
"default_value" VARCHAR,
"description" VARCHAR,
"apply_type" VARCHAR,
"data_type" VARCHAR,
"allowed_values" VARCHAR,
"is_modifiable" BOOLEAN,
"is_collection" BOOLEAN
)[],
"db_security_group_memberships" STRUCT(
"db_security_group_name" VARCHAR,
"status" VARCHAR
)[],
"vpc_security_group_memberships" STRUCT(
"vpc_security_group_id" VARCHAR,
"status" VARCHAR
)[]
)[]
Show child fields
options[]
Show child fields
options[].db_security_group_memberships[]
Show child fields
options[].db_security_group_memberships[].db_security_group_name

The name of the DB security group.

options[].db_security_group_memberships[].status

The status of the DB security group.

options[].option_description

The description of the option.

options[].option_name

The name of the option.

options[].option_settings[]
Show child fields
options[].option_settings[].allowed_values

The allowed values of the option setting.

options[].option_settings[].apply_type

The DB engine specific parameter type.

options[].option_settings[].data_type

The data type of the option setting.

options[].option_settings[].default_value

The default value of the option setting.

options[].option_settings[].description

The description of the option setting.

options[].option_settings[].is_collection

Indicates whether the option setting is part of a collection.

options[].option_settings[].is_modifiable

Indicates whether the option setting can be modified from the default.

options[].option_settings[].name

The name of the option that has settings that you can set.

options[].option_settings[].value

The current value of the option setting.

options[].option_version

The version of the option.

options[].permanent

Indicates whether this option is permanent.

options[].persistent

Indicates whether this option is persistent.

options[].port

If required, the port configured for this option to use.

options[].vpc_security_group_memberships[]
Show child fields
options[].vpc_security_group_memberships[].status

The membership status of the VPC security group.

Currently, the only valid status is active.

options[].vpc_security_group_memberships[].vpc_security_group_id

The name of the VPC security group.

source_account_id

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

VARCHAR
source_option_group

Specifies the name of the option group from which this option group is copied.

VARCHAR
vpc_id

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

VARCHAR