interface IOptionGroup

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

Implemented by OptionGroup

Obtainable from OptionGroup.fromOptionGroupName()

An option group.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
optionGroupName	string	The name of the option group.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

optionGroupName

Type: string

The name of the option group.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addConfiguration(configuration)	Adds a configuration to this OptionGroup.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

addConfiguration(configuration)

public addConfiguration(configuration: OptionConfiguration): boolean

Parameters

• configuration OptionConfiguration

Returns

• boolean

Adds a configuration to this OptionGroup.

This method is a no-op for an imported OptionGroup.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).