Interface ICfnOptionGroupProps

Properties for defining a CfnOptionGroup.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnOptionGroupProps

Syntax (vb)

Public Interface ICfnOptionGroupProps

Remarks

See: 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 cfnOptionGroupProps = 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

Properties

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 all available options for an option group.
OptionGroupDescription	The description of the option group.
OptionGroupName	The name of the option group to be created.
Tags	Tags to assign to the option group.

Properties

EngineName

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

string EngineName { get; }

Property Value

string

Remarks

Valid Values:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename

MajorEngineVersion

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

string MajorEngineVersion { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion

OptionConfigurations

A list of all available options for an option group.

object? OptionConfigurations { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations

Type union: either IResolvable or (either IResolvable or CfnOptionGroup.IOptionConfigurationProperty)[]

OptionGroupDescription

The description of the option group.

string OptionGroupDescription { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription

OptionGroupName

The name of the option group to be created.

string? OptionGroupName { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupname