Show / Hide Table of Contents

Class SubnetGroup

Class for creating a RDS DB subnet group.

Inheritance
System.Object
Construct
Resource
SubnetGroup
Implements
ISubnetGroup
IResource
IConstruct
Constructs.IConstruct
IDependable
Inherited Members
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(String, IArnComponents)
Resource.GetResourceNameAttribute(String)
Resource.Env
Resource.PhysicalName
Resource.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class SubnetGroup : Resource, ISubnetGroup, IResource, IConstruct, IDependable
Syntax (vb)
Public Class SubnetGroup
    Inherits Resource
    Implements ISubnetGroup, IResource, IConstruct, IDependable
Remarks

Resource: AWS::RDS::DBSubnetGroup

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 subnetGroup = new SubnetGroup(this, "MySubnetGroup", 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

Constructors

SubnetGroup(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

SubnetGroup(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

SubnetGroup(Construct, String, ISubnetGroupProps)

Properties

SubnetGroupName

The name of the subnet group.

Methods

FromSubnetGroupName(Construct, String, String)

Imports an existing subnet group by name.

Constructors

SubnetGroup(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected SubnetGroup(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

SubnetGroup(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected SubnetGroup(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

SubnetGroup(Construct, String, ISubnetGroupProps)

public SubnetGroup(Construct scope, string id, ISubnetGroupProps props)
Parameters
scope Constructs.Construct
id System.String
props ISubnetGroupProps

Properties

SubnetGroupName

The name of the subnet group.

public virtual string SubnetGroupName { get; }
Property Value

System.String

Methods

FromSubnetGroupName(Construct, String, String)

Imports an existing subnet group by name.

public static ISubnetGroup FromSubnetGroupName(Construct scope, string id, string subnetGroupName)
Parameters
scope Constructs.Construct
id System.String
subnetGroupName System.String
Returns

ISubnetGroup

Implements

ISubnetGroup
IResource
IConstruct
Constructs.IConstruct
IDependable
Back to top Generated by DocFX