AWS Fundamentals Logo
AWS Fundamentals
AWS::RDS::OptionGroup

RDS OptionGroup

The AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.

Properties

6 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
EngineName
string
RequiredCreate-only
MajorEngineVersion
string
RequiredCreate-only
OptionGroupDescription
string
RequiredCreate-only
OptionConfigurations
Array<OptionConfiguration>
OptionGroupName
string
Create-only
Tags
Array<Tag>

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::RDS::OptionGroup

Resources:
  MyResource:
    Type: AWS::RDS::OptionGroup
    Properties:
      EngineName: "my-enginename"
      MajorEngineVersion: "value"
      OptionGroupDescription: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:CreateServiceLinkedRolerds:AddTagsToResourcerds:CreateOptionGrouprds:DescribeOptionGroupsrds:ListTagsForResourcerds:ModifyOptionGrouprds:RemoveTagsFromResource

read

rds:DescribeOptionGroupsrds:ListTagsForResource

update

rds:AddTagsToResourcerds:DescribeOptionGroupsrds:ListTagsForResourcerds:ModifyOptionGrouprds:RemoveTagsFromResource

delete

rds:DeleteOptionGrouprds:DescribeOptionGroupsrds:ListTagsForResourcerds:RemoveTagsFromResource

list

rds:DescribeOptionGroups

Get the RDS Cheat Sheet

Everything you need to know about RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceRDS
Properties6
Required3
TaggingSupported
Primary IDOptionGroupName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

EngineNameMajorEngineVersionOptionGroupDescriptionOptionGroupName

Related Resources

External Links