software.amazon.awscdk.services.rds

Class CfnOptionGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.rds.CfnOptionGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.429Z")
 @Stability(value=Stable)
public class CfnOptionGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RDS::OptionGroup`.

The AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.

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.*;
 CfnOptionGroup cfnOptionGroup = CfnOptionGroup.Builder.create(this, "MyCfnOptionGroup")
         .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()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnOptionGroup.Builder A fluent builder for CfnOptionGroup.
static interface	CfnOptionGroup.OptionConfigurationProperty The `OptionConfiguration` property type specifies an individual option, and its settings, within an `AWS::RDS::OptionGroup` resource.
static interface	CfnOptionGroup.OptionSettingProperty The `OptionSetting` property type specifies the value for an option within an `OptionSetting` property.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnOptionGroup(software.constructs.Construct scope, String id, CfnOptionGroupProps props) Create a new `AWS::RDS::OptionGroup`.
protected	CfnOptionGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnOptionGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrOptionGroupName()
protected Map<String,Object>	getCfnProperties()
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.
Object	getOptionConfigurations() A list of options and the settings for each option.
String	getOptionGroupDescription() The description of the option group.
TagManager	getTags() Tags to assign to the option group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEngineName(String value) Specifies the name of the engine that this option group should be associated with.
void	setMajorEngineVersion(String value) Specifies the major version of the engine that this option group should be associated with.
void	setOptionConfigurations(IResolvable value) A list of options and the settings for each option.
void	setOptionConfigurations(List<Object> value) A list of options and the settings for each option.
void	setOptionGroupDescription(String value) The description of the option group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnOptionGroup

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

CfnOptionGroup

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

CfnOptionGroup

@Stability(value=Stable)
public CfnOptionGroup(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnOptionGroupProps props)

Create a new `AWS::RDS::OptionGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrOptionGroupName

@Stability(value=Stable)
 @NotNull
public String getAttrOptionGroupName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Tags to assign to the option group.

getEngineName

@Stability(value=Stable)
 @NotNull
public String getEngineName()

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

Valid Values:

• mariadb
• mysql
• oracle-ee
• oracle-se2
• oracle-se1
• oracle-se
• postgres
• sqlserver-ee
• sqlserver-se
• sqlserver-ex
• sqlserver-web

setEngineName

@Stability(value=Stable)
public void setEngineName(@NotNull
                                                   String value)

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

Valid Values:

• mariadb
• mysql
• oracle-ee
• oracle-se2
• oracle-se1
• oracle-se
• postgres
• sqlserver-ee
• sqlserver-se
• sqlserver-ex
• sqlserver-web

getMajorEngineVersion

@Stability(value=Stable)
 @NotNull
public String getMajorEngineVersion()

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

setMajorEngineVersion

@Stability(value=Stable)
public void setMajorEngineVersion(@NotNull
                                                           String value)

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

getOptionGroupDescription

@Stability(value=Stable)
 @NotNull
public String getOptionGroupDescription()

The description of the option group.

setOptionGroupDescription

@Stability(value=Stable)
public void setOptionGroupDescription(@NotNull
                                                               String value)

The description of the option group.

getOptionConfigurations

@Stability(value=Stable)
 @Nullable
public Object getOptionConfigurations()

A list of options and the settings for each option.

setOptionConfigurations

@Stability(value=Stable)
public void setOptionConfigurations(@Nullable
                                                             IResolvable value)

A list of options and the settings for each option.

setOptionConfigurations

@Stability(value=Stable)
public void setOptionConfigurations(@Nullable
                                                             List<Object> value)

A list of options and the settings for each option.