Interface IOptionConfiguration
Configuration properties for an option.
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public interface IOptionConfiguration
Syntax (vb)
Public Interface 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
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 |
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. |
Properties
Name
The name of the option.
string Name { get; }
Property Value
System.String
Port
The port number that this option uses.
virtual Nullable<double> Port { get; }
Property Value
System.Nullable<System.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.
virtual ISecurityGroup[] SecurityGroups { get; }
Property Value
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.
virtual IDictionary<string, string> Settings { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - no settings
Version
The version for the option.
virtual string Version { get; }
Property Value
System.String
Remarks
Default: - no version
Vpc
The VPC where a security group should be created for this option.
virtual IVpc Vpc { get; }
Property Value
Remarks
If vpc
is specified then port
must also be specified.
Default: - no VPC