aws-cdk-lib.aws_rds.CfnOptionGroupProps

interface CfnOptionGroupProps

LanguageType name
.NETAmazon.CDK.AWS.RDS.CfnOptionGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnOptionGroupProps
Javasoftware.amazon.awscdk.services.rds.CfnOptionGroupProps
Pythonaws_cdk.aws_rds.CfnOptionGroupProps
TypeScript aws-cdk-lib » aws_rds » CfnOptionGroupProps

Properties for defining a CfnOptionGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnOptionGroupProps: rds.CfnOptionGroupProps = {
  engineName: 'engineName',
  majorEngineVersion: 'majorEngineVersion',
  optionGroupDescription: 'optionGroupDescription',

  // the properties below are optional
  optionConfigurations: [{
    optionName: 'optionName',

    // the properties below are optional
    dbSecurityGroupMemberships: ['dbSecurityGroupMemberships'],
    optionSettings: [{
      name: 'name',
      value: 'value',
    }],
    optionVersion: 'optionVersion',
    port: 123,
    vpcSecurityGroupMemberships: ['vpcSecurityGroupMemberships'],
  }],
  optionGroupName: 'optionGroupName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
engineNamestringSpecifies the name of the engine that this option group should be associated with.
majorEngineVersionstringSpecifies the major version of the engine that this option group should be associated with.
optionGroupDescriptionstringThe description of the option group.
optionConfigurations?IResolvable | IResolvable | OptionConfigurationProperty[]A list of options and the settings for each option.
optionGroupName?stringThe name of the option group to be created.
tags?CfnTag[]An optional array of key-value pairs to apply to this option group.

engineName

Type: 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

majorEngineVersion

Type: string

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


optionGroupDescription

Type: string

The description of the option group.


optionConfigurations?

Type: IResolvable | IResolvable | OptionConfigurationProperty[] (optional)

A list of options and the settings for each option.


optionGroupName?

Type: string (optional)

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.


tags?

Type: CfnTag[] (optional)

An optional array of key-value pairs to apply to this option group.