Class CfnDBSubnetGroup

A CloudFormation AWS::RDS::DBSubnetGroup.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnDBSubnetGroup
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class CfnDBSubnetGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDBSubnetGroup
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.

For more information, see Working with DB subnet groups in the Amazon RDS User Guide .

CloudformationResource: AWS::RDS::DBSubnetGroup

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html

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.RDS;

var cfnDBSubnetGroup = new CfnDBSubnetGroup(this, "MyCfnDBSubnetGroup", new CfnDBSubnetGroupProps {
    DbSubnetGroupDescription = "dbSubnetGroupDescription",
    SubnetIds = new [] { "subnetIds" },

    // the properties below are optional
    DbSubnetGroupName = "dbSubnetGroupName",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnDBSubnetGroup(Construct, String, ICfnDBSubnetGroupProps)

Create a new AWS::RDS::DBSubnetGroup.
CfnDBSubnetGroup(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnDBSubnetGroup(DeputyBase.DeputyProps)

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

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
DbSubnetGroupDescription

The description for the DB subnet group.
DbSubnetGroupName

The name for the DB subnet group. This value is stored as a lowercase string.
SubnetIds

The EC2 Subnet IDs for the DB subnet group.
Tags

An optional array of key-value pairs to apply to this DB subnet group.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnDBSubnetGroup(Construct, String, ICfnDBSubnetGroupProps)

Create a new AWS::RDS::DBSubnetGroup.

public CfnDBSubnetGroup(Construct scope, string id, ICfnDBSubnetGroupProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnDBSubnetGroupProps
  • resource properties.

CfnDBSubnetGroup(ByRefValue)

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

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

The Javascript-owned object reference

CfnDBSubnetGroup(DeputyBase.DeputyProps)

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

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

The deputy props

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

DbSubnetGroupDescription

The description for the DB subnet group.

public virtual string DbSubnetGroupDescription { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupdescription

DbSubnetGroupName

The name for the DB subnet group. This value is stored as a lowercase string.

public virtual string DbSubnetGroupName { get; set; }
Property Value

System.String

Remarks

Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default".

Example: mysubnetgroup

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname

SubnetIds

The EC2 Subnet IDs for the DB subnet group.

public virtual string[] SubnetIds { get; set; }
Property Value

System.String[]

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-subnetids

Tags

An optional array of key-value pairs to apply to this DB subnet group.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-tags

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct