Class CfnOptionGroupProps

Properties for defining a CfnOptionGroup.

Inheritance

object

CfnOptionGroupProps

Implements

ICfnOptionGroupProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnOptionGroupProps : ICfnOptionGroupProps

Syntax (vb)

Public Class CfnOptionGroupProps Implements 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

Constructors

CfnOptionGroupProps()

Properties for defining a CfnOptionGroup.

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.

Constructors

CfnOptionGroupProps()

Properties for defining a CfnOptionGroup.

public CfnOptionGroupProps()

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"
                 } }
             };

Properties

EngineName

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

public string EngineName { get; set; }

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.

public string MajorEngineVersion { get; set; }

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.

public object? OptionConfigurations { get; set; }

Property Value

object

Remarks

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

OptionGroupDescription

The description of the option group.

public string OptionGroupDescription { get; set; }

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.

public string? OptionGroupName { get; set; }

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

Implements

ICfnOptionGroupProps