Skip to content
v2.274.0

OptionGroupProps Struct ​

Construction properties for an OptionGroup.

Example ​

ts
declare const vpc: ec2.Vpc;
declare const securityGroup: ec2.SecurityGroup;

new rds.OptionGroup(this, 'Options', {
  engine: rds.DatabaseInstanceEngine.oracleSe2({
    version: rds.OracleEngineVersion.VER_19,
  }),
  configurations: [
    {
      name: 'OEM',
      port: 5500,
      vpc,
      securityGroups: [securityGroup], // Optional - a default group will be created if not provided.
    },
  ],
  optionGroupName: 'MyOptionGroup'
});

Properties ​

configurationsOptionConfiguration[]configurationstyping.List[OptionConfiguration]configurationsList<OptionConfiguration>ConfigurationsOptionConfiguration[]Configurations*[]OptionConfigurationrequired#
The configurations for this option group.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the option group.

Default: a CDK generated description

The database engine that this option group is associated with.
optionGroupNameoptionalstringoption_group_nameoptionalstroptionGroupNameoptionalStringOptionGroupNameoptionalstringOptionGroupNameoptional*string#
The name of the option group.

Default: a CDK generated name