Class OptionConfiguration

Configuration properties for an option.

Inheritance

object

OptionConfiguration

Implements

IOptionConfiguration

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 OptionConfiguration : IOptionConfiguration

Syntax (vb)

Public Class OptionConfiguration Implements IOptionConfiguration

Remarks

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.EC2;
            using Amazon.CDK.AWS.RDS;

            SecurityGroup securityGroup;
            Vpc vpc;

            var optionConfiguration = new OptionConfiguration {
                Name = "name",

                // the properties below are optional
                Port = 123,
                SecurityGroups = new [] { securityGroup },
                Settings = new Dictionary<string, string> {
                    { "settingsKey", "settings" }
                },
                Version = "version",
                Vpc = vpc
            };

Synopsis

Constructors

OptionConfiguration()

Configuration properties for an option.

Properties

Name	The name of the option.
Port	The port number that this option uses.
SecurityGroups	Optional list of security groups to use for this option, if `vpc` is specified.
Settings	The settings for the option.
Version	The version for the option.
Vpc	The VPC where a security group should be created for this option.

Constructors

OptionConfiguration()

Configuration properties for an option.

public OptionConfiguration()

Remarks

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.EC2;
            using Amazon.CDK.AWS.RDS;

            SecurityGroup securityGroup;
            Vpc vpc;

            var optionConfiguration = new OptionConfiguration {
                Name = "name",

                // the properties below are optional
                Port = 123,
                SecurityGroups = new [] { securityGroup },
                Settings = new Dictionary<string, string> {
                    { "settingsKey", "settings" }
                },
                Version = "version",
                Vpc = vpc
            };

Properties

Name

The name of the option.

public string Name { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Port

The port number that this option uses.

public double? Port { get; set; }

Property Value

double?

Remarks

If port is specified then vpc must also be specified.

Default: - no port

SecurityGroups

Optional list of security groups to use for this option, if vpc is specified.

public ISecurityGroup[]? SecurityGroups { get; set; }

Property Value

ISecurityGroup[]

Remarks

If no groups are provided, a default one will be created.

Default: - a default group will be created if port or vpc are specified.

Settings

The settings for the option.

public IDictionary<string, string>? Settings { get; set; }

Property Value

IDictionary<string, string>

Remarks

Default: - no settings

Version

The version for the option.

public string? Version { get; set; }

Property Value

string

Remarks

Default: - no version

Vpc

The VPC where a security group should be created for this option.

public IVpc? Vpc { get; set; }

Property Value

IVpc

Remarks

If vpc is specified then port must also be specified.

Default: - no VPC

Implements

IOptionConfiguration