Package software.amazon.awscdk.services.rds

Class OptionGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.rds.OptionGroup

All Implemented Interfaces:

IEnvironmentAware, IOptionGroupRef, IResource, IOptionGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-27T13:12:06.398Z")
@Stability(Stable)
public class OptionGroup
extends Resource
implements IOptionGroup

An option group.

Example:

 Vpc vpc;
 SecurityGroup securityGroup;
 OptionGroup.Builder.create(this, "Options")
         .engine(DatabaseInstanceEngine.oracleSe2(OracleSe2InstanceEngineProps.builder()
                 .version(OracleEngineVersion.VER_19)
                 .build()))
         .configurations(List.of(OptionConfiguration.builder()
                 .name("OEM")
                 .port(5500)
                 .vpc(vpc)
                 .securityGroups(List.of(securityGroup))
                 .build()))
         .optionGroupName("MyOptionGroup")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OptionGroup.Builder	A fluent builder for OptionGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IOptionGroup

IOptionGroup.Jsii$Default, IOptionGroup.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OptionGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	OptionGroup(software.amazon.jsii.JsiiObjectRef objRef)
	OptionGroup(software.constructs.Construct scope, String id, OptionGroupProps props)

Method Summary

Modifier and Type	Method	Description
Boolean	addConfiguration(OptionConfiguration configuration)	Adds a configuration to this OptionGroup.
static IOptionGroup	fromOptionGroupName(software.constructs.Construct scope, String id, String optionGroupName)	Import an existing option group.
Map<String,Connections>	getOptionConnections()	The connections object for the options.
String	getOptionGroupName()	The name of the option group.
OptionGroupReference	getOptionGroupRef()	A reference to a OptionGroup resource.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

OptionGroup

protected OptionGroup(software.amazon.jsii.JsiiObjectRef objRef)

OptionGroup

protected OptionGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

OptionGroup

@Stability(Stable)
public OptionGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 OptionGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromOptionGroupName

@Stability(Stable)
@NotNull
public static IOptionGroup fromOptionGroupName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String optionGroupName)

Import an existing option group.

Parameters:

scope - This parameter is required.

id - This parameter is required.

optionGroupName - This parameter is required.

addConfiguration

@Stability(Stable)
@NotNull
public Boolean addConfiguration(@NotNull
 OptionConfiguration configuration)

Adds a configuration to this OptionGroup.

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

Specified by:

addConfiguration in interface IOptionGroup

Parameters:

configuration - This parameter is required.

Returns:

true if the OptionConfiguration was successfully added.

getOptionConnections

@Stability(Stable)
@NotNull
public Map<String,Connections> getOptionConnections()

The connections object for the options.

getOptionGroupName

@Stability(Stable)
@NotNull
public String getOptionGroupName()

The name of the option group.

Specified by:

getOptionGroupName in interface IOptionGroup

getOptionGroupRef

@Stability(Stable)
@NotNull
public OptionGroupReference getOptionGroupRef()

A reference to a OptionGroup resource.

Specified by:

getOptionGroupRef in interface IOptionGroupRef