Interface CfnOptionGroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnOptionGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2025-01-10T21:56:58.397Z")
@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:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnOptionGroupProps
static final class
An implementation forCfnOptionGroupProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnOptionGroupProps.Builder
builder()
Specifies the name of the engine that this option group should be associated with.Specifies the major version of the engine that this option group should be associated with.default Object
A list of all available options for an option group.The description of the option group.default String
The name of the option group to be created.getTags()
Tags to assign to the option group.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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:
-
getMajorEngineVersion
Specifies the major version of the engine that this option group should be associated with.- See Also:
-
getOptionGroupDescription
The description of the option group.- See Also:
-
getOptionConfigurations
A list of all available options for an option group.- See Also:
-
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:
-
getTags
Tags to assign to the option group.- See Also:
-
builder
- Returns:
- a
CfnOptionGroupProps.Builder
ofCfnOptionGroupProps
-