software.amazon.awscdk.services.rds

Class CfnOptionGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.rds.CfnOptionGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.173Z")
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()))
         .optionGroupName("optionGroupName")
         .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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnOptionGroup(Construct scope, java.lang.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
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getEngineName() Specifies the name of the engine that this option group should be associated with.
java.lang.String	getMajorEngineVersion() Specifies the major version of the engine that this option group should be associated with.
java.lang.Object	getOptionConfigurations() A list of options and the settings for each option.
java.lang.String	getOptionGroupDescription() The description of the option group.
java.lang.String	getOptionGroupName() The name of the option group to be created.
TagManager	getTags() An optional array of key-value pairs to apply to this option group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setEngineName(java.lang.String value) Specifies the name of the engine that this option group should be associated with.
void	setMajorEngineVersion(java.lang.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(java.util.List<java.lang.Object> value) A list of options and the settings for each option.
void	setOptionGroupDescription(java.lang.String value) The description of the option group.
void	setOptionGroupName(java.lang.String value) The name of the option group to be created.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnOptionGroup(Construct scope,
                      java.lang.String id,
                      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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An optional array of key-value pairs to apply to this option group.

getEngineName

public java.lang.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

setEngineName

public void setEngineName(java.lang.String value)

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

getMajorEngineVersion

public java.lang.String getMajorEngineVersion()

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

setMajorEngineVersion

public void setMajorEngineVersion(java.lang.String value)

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

getOptionGroupDescription

public java.lang.String getOptionGroupDescription()

The description of the option group.

setOptionGroupDescription

public void setOptionGroupDescription(java.lang.String value)

The description of the option group.

getOptionConfigurations

public java.lang.Object getOptionConfigurations()

A list of options and the settings for each option.

setOptionConfigurations

public void setOptionConfigurations(IResolvable value)

A list of options and the settings for each option.

setOptionConfigurations

public void setOptionConfigurations(java.util.List<java.lang.Object> value)

A list of options and the settings for each option.

getOptionGroupName

public java.lang.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.

setOptionGroupName

public void setOptionGroupName(java.lang.String value)

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.