Interface ISubnetGroupProps

Properties for creating a SubnetGroup.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.AWS.RDS.dll

Syntax (csharp)

public interface ISubnetGroupProps

Syntax (vb)

Public Interface ISubnetGroupProps

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

Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
var subnetGroupProps = new SubnetGroupProps {
    Description = "description",
    Vpc = vpc,

    // the properties below are optional
    RemovalPolicy = RemovalPolicy.DESTROY,
    SubnetGroupName = "subnetGroupName",
    VpcSubnets = new SubnetSelection {
        AvailabilityZones = new [] { "availabilityZones" },
        OnePerAz = false,
        SubnetFilters = new [] { subnetFilter },
        SubnetGroupName = "subnetGroupName",
        SubnetName = "subnetName",
        Subnets = new [] { subnet },
        SubnetType = SubnetType.ISOLATED
    }
};

Synopsis

Properties

Description	Description of the subnet group.
RemovalPolicy	The removal policy to apply when the subnet group are removed from the stack or replaced during an update.
SubnetGroupName	The name of the subnet group.
Vpc	The VPC to place the subnet group in.
VpcSubnets	Which subnets within the VPC to associate with this group.

Properties

Description

Description of the subnet group.

string Description { get; }

Property Value

System.String

RemovalPolicy

The removal policy to apply when the subnet group are removed from the stack or replaced during an update.

virtual Nullable<RemovalPolicy> RemovalPolicy { get; }

Property Value

System.Nullable<RemovalPolicy>

Remarks

Default: RemovalPolicy.DESTROY

SubnetGroupName

The name of the subnet group.

virtual string SubnetGroupName { get; }

Property Value

System.String

Remarks

Default: - a name is generated

Vpc

The VPC to place the subnet group in.

IVpc Vpc { get; }

Property Value

IVpc

VpcSubnets

Which subnets within the VPC to associate with this group.

virtual ISubnetSelection VpcSubnets { get; }

Property Value

ISubnetSelection

Remarks

Default: - private subnets