option_groups

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

Overview

Name	option_groups
Type	Resource
Id	aws.rds.option_groups

Fields

The following fields are returned by SELECT queries:

describe_option_groups

Name	Datatype	Description
allows_vpc_and_non_vpc_instance_memberships	boolean	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.
copy_timestamp	string	Indicates when the option group was copied.
engine_name	string	Indicates the name of the engine that this option group can be applied to.
major_engine_version	string	Indicates the major engine version associated with this option group.
option_group_arn	string	Specifies the Amazon Resource Name (ARN) for the option group.
option_group_description	string	Provides a description of the option group.
option_group_name	string	Specifies the name of the option group.
options	string	Indicates what options are available in the option group.
source_account_id	string	Specifies the Amazon Web Services account ID for the option group from which this option group is copied.
source_option_group	string	Specifies the name of the option group from which this option group is copied.
vpc_id	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_option_groups	select	region	OptionGroupName, Filters, Marker, MaxRecords, EngineName, MajorEngineVersion	Describes the available option groups.
create_option_group	insert	OptionGroupName, EngineName, MajorEngineVersion, OptionGroupDescription, region	Tags	Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom.
modify_option_group	update	OptionGroupName, region	OptionsToInclude, OptionsToRemove, ApplyImmediately	Modifies an existing option group.
delete_option_group	delete	OptionGroupName, region		Deletes an existing option group.

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 associate this option group with. 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
MajorEngineVersion	string	Specifies the major version of the engine that this option group should be associated with.
OptionGroupDescription	string	The description of the option group.
OptionGroupName	string	The name of the option group to be deleted. You can't delete default option groups.
region	string	AWS region (default: us-east-1)
ApplyImmediately	boolean	Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
EngineName	string	A filter to only include option groups associated with this database engine. 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
Filters	array	This parameter isn't currently supported.
MajorEngineVersion	string	Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
Marker	string	An optional pagination token provided by a previous DescribeOptionGroups 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.
OptionGroupName	string	The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
OptionsToInclude	array	Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
OptionsToRemove	array	Options in this list are removed from the option group.
Tags	array	Tags to assign to the option group.

SELECT examples

describe_option_groups

Describes the available option groups.

SELECT
allows_vpc_and_non_vpc_instance_memberships,
copy_timestamp,
engine_name,
major_engine_version,
option_group_arn,
option_group_description,
option_group_name,
options,
source_account_id,
source_option_group,
vpc_id
FROM aws.rds.option_groups
WHERE region = '{{ region }}' -- required
AND OptionGroupName = '{{ OptionGroupName }}'
AND Filters = '{{ Filters }}'
AND Marker = '{{ Marker }}'
AND MaxRecords = '{{ MaxRecords }}'
AND EngineName = '{{ EngineName }}'
AND MajorEngineVersion = '{{ MajorEngineVersion }}'
;

INSERT examples

create_option_group

Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom.

INSERT INTO aws.rds.option_groups (
OptionGroupName,
EngineName,
MajorEngineVersion,
OptionGroupDescription,
region,
Tags
)
SELECT 
'{{ OptionGroupName }}',
'{{ EngineName }}',
'{{ MajorEngineVersion }}',
'{{ OptionGroupDescription }}',
'{{ region }}',
'{{ Tags }}'
RETURNING
allows_vpc_and_non_vpc_instance_memberships,
copy_timestamp,
engine_name,
major_engine_version,
option_group_arn,
option_group_description,
option_group_name,
options,
source_account_id,
source_option_group,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: option_groups
props:
  - name: OptionGroupName
    value: "{{ OptionGroupName }}"
    description: Required parameter for the option_groups resource.
  - name: EngineName
    value: "{{ EngineName }}"
    description: Required parameter for the option_groups resource.
  - name: MajorEngineVersion
    value: "{{ MajorEngineVersion }}"
    description: Required parameter for the option_groups resource.
  - name: OptionGroupDescription
    value: "{{ OptionGroupDescription }}"
    description: Required parameter for the option_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the option_groups resource.
  - name: Tags
    value: "{{ Tags }}"
    description: Tags to assign to the option group.
    description: Tags to assign to the option group.

UPDATE examples

modify_option_group

Modifies an existing option group.

UPDATE aws.rds.option_groups
SET 
-- No updatable properties
WHERE 
OptionGroupName = '{{ OptionGroupName }}' --required
AND region = '{{ region }}' --required
AND OptionsToInclude = '{{ OptionsToInclude}}'
AND OptionsToRemove = '{{ OptionsToRemove}}'
AND ApplyImmediately = {{ ApplyImmediately}}
RETURNING
allows_vpc_and_non_vpc_instance_memberships,
copy_timestamp,
engine_name,
major_engine_version,
option_group_arn,
option_group_description,
option_group_name,
options,
source_account_id,
source_option_group,
vpc_id;

DELETE examples

delete_option_group

Deletes an existing option group.

DELETE FROM aws.rds.option_groups
WHERE OptionGroupName = '{{ OptionGroupName }}' --required
AND region = '{{ region }}' --required
;