Interface ISubnetGroupProps

(experimental) Properties for creating a SubnetGroup.

Namespace: Amazon.CDK.AWS.Neptune.Alpha

Assembly: Amazon.CDK.AWS.Neptune.Alpha.dll

Syntax (csharp)

public interface ISubnetGroupProps

Syntax (vb)

Public Interface ISubnetGroupProps

Remarks

Stability: Experimental

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

             Subnet subnet;
             SubnetFilter subnetFilter;
             Vpc vpc;

             var subnetGroupProps = new SubnetGroupProps {
                 Vpc = vpc,

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

Synopsis

Properties

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

Properties

Description

(experimental) Description of the subnet group.

string? Description { get; }

Property Value

string

Remarks

Default: - a name is generated

Stability: Experimental

RemovalPolicy

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

RemovalPolicy? RemovalPolicy { get; }

Property Value

RemovalPolicy?

Remarks

Default: RemovalPolicy.DESTROY

Stability: Experimental

SubnetGroupName

(experimental) The name of the subnet group.

string? SubnetGroupName { get; }

Property Value

string

Remarks

Default: - a name is generated

Stability: Experimental

Vpc

(experimental) The VPC to place the subnet group in.

IVpc Vpc { get; }

Property Value

IVpc

Remarks

Stability: Experimental

VpcSubnets

(experimental) Which subnets within the VPC to associate with this group.

ISubnetSelection? VpcSubnets { get; }

Property Value

ISubnetSelection

Remarks

Default: - private subnets

Stability: Experimental