option_groups

Creates, updates, deletes or gets an option_group resource or lists option_groups in a region

Overview

Name	`option_groups`
Type	Resource
Description	The ``AWS::RDS::OptionGroup`` resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.
Id	`awscc.rds.option_groups`

Fields

Name	Datatype	Description
`option_group_name`	`string`	The name of the option group to be created.<br />Constraints:<br />+ Must be 1 to 255 letters, numbers, or hyphens<br />+ First character must be a letter<br />+ Can't end with a hyphen or contain two consecutive hyphens<br /><br />Example: ``myoptiongroup``<br />If you don't specify a value for ``OptionGroupName`` property, a name is automatically created for the option group.<br />This value is stored as a lowercase string.
`option_group_description`	`string`	The description of the option group.
`engine_name`	`string`	Specifies the name of the engine that this option group should be associated with.<br />Valid Values: <br />+ ``mariadb`` <br />+ ``mysql`` <br />+ ``oracle-ee`` <br />+ ``oracle-ee-cdb`` <br />+ ``oracle-se2`` <br />+ ``oracle-se2-cdb`` <br />+ ``postgres`` <br />+ ``sqlserver-ee`` <br />+ ``sqlserver-se`` <br />+ ``sqlserver-ex`` <br />+ ``sqlserver-web``
`major_engine_version`	`string`	Specifies the major version of the engine that this option group should be associated with.
▶`option_configurations`	`array`	A list of all available options for an option group.
▶`tags`	`array`	Tags to assign to the option group.
`region`	`string`	AWS region.

For more information, see AWS::RDS::OptionGroup.

Methods

Name	Accessible by	Required Params
`create_resource`	`INSERT`	`EngineName, MajorEngineVersion, OptionGroupDescription, region`
`delete_resource`	`DELETE`	`data__Identifier, region`
`update_resource`	`UPDATE`	`data__Identifier, data__PatchDocument, region`
`list_resources`	`SELECT`	`region`
`get_resource`	`SELECT`	`data__Identifier, region`

`SELECT` examples

Gets all properties from an individual option_group.

SELECT
region,
option_group_name,
option_group_description,
engine_name,
major_engine_version,
option_configurations,
tags
FROM awscc.rds.option_groups
WHERE region = 'us-east-1' AND data__Identifier = '<OptionGroupName>';

`INSERT` example

Use the following StackQL query and manifest file to create a new option_group resource, using stack-deploy.

Required Properties
All Properties
Manifest

/*+ create */
INSERT INTO awscc.rds.option_groups (
 OptionGroupDescription,
 EngineName,
 MajorEngineVersion,
 region
)
SELECT 
'{{ OptionGroupDescription }}',
 '{{ EngineName }}',
 '{{ MajorEngineVersion }}',
'{{ region }}';

/*+ create */
INSERT INTO awscc.rds.option_groups (
 OptionGroupName,
 OptionGroupDescription,
 EngineName,
 MajorEngineVersion,
 OptionConfigurations,
 Tags,
 region
)
SELECT 
 '{{ OptionGroupName }}',
 '{{ OptionGroupDescription }}',
 '{{ EngineName }}',
 '{{ MajorEngineVersion }}',
 '{{ OptionConfigurations }}',
 '{{ Tags }}',
 '{{ region }}';

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: option_group
    props:
      - name: OptionGroupName
        value: '{{ OptionGroupName }}'
      - name: OptionGroupDescription
        value: '{{ OptionGroupDescription }}'
      - name: EngineName
        value: '{{ EngineName }}'
      - name: MajorEngineVersion
        value: '{{ MajorEngineVersion }}'
      - name: OptionConfigurations
        value:
          - DBSecurityGroupMemberships:
              - '{{ DBSecurityGroupMemberships[0] }}'
            OptionName: '{{ OptionName }}'
            OptionSettings:
              - Name: '{{ Name }}'
                Value: '{{ Value }}'
            OptionVersion: '{{ OptionVersion }}'
            Port: '{{ Port }}'
            VpcSecurityGroupMemberships:
              - '{{ VpcSecurityGroupMemberships[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

`DELETE` example

/*+ delete */
DELETE FROM awscc.rds.option_groups
WHERE data__Identifier = '<OptionGroupName>'
AND region = 'us-east-1';

Permissions

To operate on the option_groups resource, the following permissions are required:

Create

iam:CreateServiceLinkedRole,
rds:AddTagsToResource,
rds:CreateOptionGroup,
rds:DescribeOptionGroups,
rds:ListTagsForResource,
rds:ModifyOptionGroup,
rds:RemoveTagsFromResource

Read

rds:DescribeOptionGroups,
rds:ListTagsForResource

Update

rds:AddTagsToResource,
rds:DescribeOptionGroups,
rds:ListTagsForResource,
rds:ModifyOptionGroup,
rds:RemoveTagsFromResource

Delete

rds:DeleteOptionGroup,
rds:DescribeOptionGroups,
rds:ListTagsForResource,
rds:RemoveTagsFromResource

List

rds:DescribeOptionGroups

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​

Permissions​

Create​

Read​

Update​

Delete​

List​