@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:51.173Z") public class CfnOptionGroup extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnOptionGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnOptionGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnOptionGroup(Construct scope, java.lang.String id, CfnOptionGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getEngineName()
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public void setEngineName(java.lang.String value)
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public java.lang.String getMajorEngineVersion()
public void setMajorEngineVersion(java.lang.String value)
public java.lang.String getOptionGroupDescription()
public void setOptionGroupDescription(java.lang.String value)
public java.lang.Object getOptionConfigurations()
public void setOptionConfigurations(IResolvable value)
public void setOptionConfigurations(java.util.List<java.lang.Object> value)
public java.lang.String getOptionGroupName()
Constraints:
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.
public void setOptionGroupName(java.lang.String value)
Constraints:
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.