Package software.amazon.awscdk.cfnpropertymixins.services.rds

Interface CfnOptionGroupMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOptionGroupMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.404Z")
@Stability(Stable)
public interface CfnOptionGroupMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnOptionGroupPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.rds.*;
 CfnOptionGroupMixinProps cfnOptionGroupMixinProps = CfnOptionGroupMixinProps.builder()
         .engineName("engineName")
         .majorEngineVersion("majorEngineVersion")
         .optionConfigurations(List.of(OptionConfigurationProperty.builder()
                 .dbSecurityGroupMemberships(List.of("dbSecurityGroupMemberships"))
                 .optionName("optionName")
                 .optionSettings(List.of(OptionSettingProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .optionVersion("optionVersion")
                 .port(123)
                 .vpcSecurityGroupMemberships(List.of("vpcSecurityGroupMemberships"))
                 .build()))
         .optionGroupDescription("optionGroupDescription")
         .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	CfnOptionGroupMixinProps.Builder	A builder for CfnOptionGroupMixinProps
static final class	CfnOptionGroupMixinProps.Jsii$Proxy	An implementation for CfnOptionGroupMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnOptionGroupMixinProps.Builder	builder()
default String	getEngineName()	Specifies the name of the engine that this option group should be associated with.
default 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.
default 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)
@Nullable
default 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)
@Nullable
default 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

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 CfnOptionGroupPropsMixin.OptionConfigurationProperty>

See Also:

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

getOptionGroupDescription

@Stability(Stable)
@Nullable
default 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

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 CfnOptionGroupMixinProps.Builder builder()

Returns:

a CfnOptionGroupMixinProps.Builder of CfnOptionGroupMixinProps