AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RDS::OptionGroup

CfnOptionGroup

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

Import

import { CfnOptionGroup } from 'aws-cdk-lib/aws-rds';

Or use the module namespace:

import * as rds from 'aws-cdk-lib/aws-rds';
// rds.CfnOptionGroup

Properties

Configuration passed to the constructor as CfnOptionGroupProps.

engineNameRequired
string

Specifies the name of the engine that this option group should be associated with. Valid Values: - `mariadb` - `mysql` - `oracle-ee` - `oracle-ee-cdb` - `oracle-se2` - `oracle-se2-cdb` - `postgres` - `sqlserver-ee` - `sqlserver-se` - `sqlserver-ex` - `sqlserver-web`

majorEngineVersionRequired
string

Specifies the major version of the engine that this option group should be associated with.

optionGroupDescriptionRequired
string

The description of the option group.

optionConfigurationsOptional
IResolvable | IResolvable | OptionConfigurationProperty[]

A list of all available options for an option group.

optionGroupNameOptional
string

The name of the option group to be created. Constraints: - Must be 1 to 255 letters, numbers, or hyphens - First character must be a letter - Can't end with a hyphen or contain two consecutive hyphens Example: `myoptiongroup` If you don't specify a value for `OptionGroupName` property, a name is automatically created for the option group. > This value is stored as a lowercase string.

tagsOptional
CfnTag[]

Tags to assign to the option group.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon RDS Cheat Sheet

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

Download Free Infographic