Class CfnOptionGroup
A CloudFormation AWS::RDS::OptionGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class CfnOptionGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnOptionGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::RDS::OptionGroup
resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.
CloudformationResource: AWS::RDS::OptionGroup
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var cfnOptionGroup = new CfnOptionGroup(this, "MyCfnOptionGroup", new CfnOptionGroupProps {
EngineName = "engineName",
MajorEngineVersion = "majorEngineVersion",
OptionGroupDescription = "optionGroupDescription",
// the properties below are optional
OptionConfigurations = new [] { new OptionConfigurationProperty {
OptionName = "optionName",
// the properties below are optional
DbSecurityGroupMemberships = new [] { "dbSecurityGroupMemberships" },
OptionSettings = new [] { new OptionSettingProperty {
Name = "name",
Value = "value"
} },
OptionVersion = "optionVersion",
Port = 123,
VpcSecurityGroupMemberships = new [] { "vpcSecurityGroupMemberships" }
} },
OptionGroupName = "optionGroupName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnOptionGroup(Construct, String, ICfnOptionGroupProps) | Create a new |
CfnOptionGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnOptionGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EngineName | Specifies the name of the engine that this option group should be associated with. |
MajorEngineVersion | Specifies the major version of the engine that this option group should be associated with. |
OptionConfigurations | A list of options and the settings for each option. |
OptionGroupDescription | The description of the option group. |
OptionGroupName | The name of the option group to be created. |
Tags | An optional array of key-value pairs to apply to this option group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnOptionGroup(Construct, String, ICfnOptionGroupProps)
Create a new AWS::RDS::OptionGroup
.
public CfnOptionGroup(Construct scope, string id, ICfnOptionGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnOptionGroupProps
- resource properties.
CfnOptionGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnOptionGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnOptionGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnOptionGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EngineName
Specifies the name of the engine that this option group should be associated with.
public virtual string EngineName { get; set; }
Property Value
System.String
Remarks
MajorEngineVersion
Specifies the major version of the engine that this option group should be associated with.
public virtual string MajorEngineVersion { get; set; }
Property Value
System.String
Remarks
OptionConfigurations
A list of options and the settings for each option.
public virtual object OptionConfigurations { get; set; }
Property Value
System.Object
Remarks
OptionGroupDescription
The description of the option group.
public virtual string OptionGroupDescription { get; set; }
Property Value
System.String
Remarks
OptionGroupName
The name of the option group to be created.
public virtual string OptionGroupName { get; set; }
Property Value
System.String
Remarks
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.
Tags
An optional array of key-value pairs to apply to this option group.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>