Package software.amazon.awscdk.services.rds

Interface CfnOptionGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOptionGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:43.777Z")
@Stability(Stable)
public interface CfnOptionGroupProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.rds.*;
 CfnOptionGroupProps cfnOptionGroupProps = CfnOptionGroupProps.builder()
         .engineName("engineName")
         .majorEngineVersion("majorEngineVersion")
         .optionGroupDescription("optionGroupDescription")
         // the properties below are optional
         .optionConfigurations(List.of(OptionConfigurationProperty.builder()
                 .optionName("optionName")
                 // the properties below are optional
                 .dbSecurityGroupMemberships(List.of("dbSecurityGroupMemberships"))
                 .optionSettings(List.of(OptionSettingProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .optionVersion("optionVersion")
                 .port(123)
                 .vpcSecurityGroupMemberships(List.of("vpcSecurityGroupMemberships"))
                 .build()))
         .optionGroupName("optionGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnOptionGroupProps.Builder	A builder for CfnOptionGroupProps
static final class	CfnOptionGroupProps.Jsii$Proxy	An implementation for CfnOptionGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnOptionGroupProps.Builder	builder()
String	getEngineName()	Specifies the name of the engine that this option group should be associated with.
String	getMajorEngineVersion()	Specifies the major version of the engine that this option group should be associated with.
default Object	getOptionConfigurations()	A list of all available options for an option group.
String	getOptionGroupDescription()	The description of the option group.
default String	getOptionGroupName()	The name of the option group to be created.
default List<CfnTag>	getTags()	Tags to assign to the option group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngineName

@Stability(Stable)
@NotNull
String getEngineName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename

getMajorEngineVersion

@Stability(Stable)
@NotNull
String getMajorEngineVersion()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion

getOptionGroupDescription

@Stability(Stable)
@NotNull
String getOptionGroupDescription()

The description of the option group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription

getOptionConfigurations

@Stability(Stable)
@Nullable
default Object getOptionConfigurations()

A list of all available options for an option group.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnOptionGroup.OptionConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations

getOptionGroupName

@Stability(Stable)
@Nullable
default String getOptionGroupName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags to assign to the option group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags

builder

@Stability(Stable)
static CfnOptionGroupProps.Builder builder()

Returns:

a CfnOptionGroupProps.Builder of CfnOptionGroupProps