interface OptionGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.RDS.OptionGroupProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#OptionGroupProps
Java	software.amazon.awscdk.services.rds.OptionGroupProps
Python	aws_cdk.aws_rds.OptionGroupProps
TypeScript (source)	aws-cdk-lib » aws_rds » OptionGroupProps

Construction properties for an OptionGroup.

Example

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

Name	Type	Description
configurations	OptionConfiguration[]	The configurations for this option group.
engine	IInstanceEngine	The database engine that this option group is associated with.
description?	string	A description of the option group.
optionGroupName?	string	The name of the option group.

---

configurations

Type: OptionConfiguration[]

The configurations for this option group.

---

engine

Type: IInstanceEngine

The database engine that this option group is associated with.

---

description?

Type: string (optional, default: a CDK generated description)

A description of the option group.

---

optionGroupName?

Type: string (optional, default: a CDK generated name)

The name of the option group.