Class CfnDBSubnetGroup

The AWS::RDS::DBSubnetGroup resource creates a database subnet group.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDBSubnetGroup

Implements

IInspectable

IDBSubnetGroupRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDBSubnetGroup : CfnResource, IInspectable, IDBSubnetGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnDBSubnetGroup Inherits CfnResource Implements IInspectable, IDBSubnetGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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 .

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

CloudformationResource: 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.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.

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::RDS::DBSubnetGroup resource creates a database subnet group.
DbSubnetGroupDescription	The description for the DB subnet group.
DbSubnetGroupName	The name for the DB subnet group.
DbSubnetGroupRef	A reference to a DBSubnetGroup resource.
SubnetIds	The EC2 Subnet IDs for the DB subnet group.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Tags to assign to the DB subnet group.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDBSubnetGroup(object)	Checks whether the given object is a CfnDBSubnetGroup.
RenderProperties(IDictionary<string, object>)	The AWS::RDS::DBSubnetGroup resource creates a database subnet group.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnDBSubnetGroupProps

Resource properties.

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::RDS::DBSubnetGroup resource creates a database subnet group.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

DbSubnetGroupDescription

The description for the DB subnet group.

public virtual string DbSubnetGroupDescription { get; set; }

Property Value

string

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

DbSubnetGroupName

The name for the DB subnet group.

public virtual string? DbSubnetGroupName { get; set; }

Property Value

string

Remarks

This value is stored as a lowercase string.

DbSubnetGroupRef

A reference to a DBSubnetGroup resource.

public virtual IDBSubnetGroupReference DbSubnetGroupRef { get; }

Property Value

IDBSubnetGroupReference

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

SubnetIds

The EC2 Subnet IDs for the DB subnet group.

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

Property Value

string[]

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

TagsRaw

Tags to assign to the DB subnet group.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

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.

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

IsCfnDBSubnetGroup(object)

Checks whether the given object is a CfnDBSubnetGroup.

public static bool IsCfnDBSubnetGroup(object x)

Parameters

x object

Returns

bool

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::RDS::DBSubnetGroup resource creates a database subnet group.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 .

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

CloudformationResource: AWS::RDS::DBSubnetGroup

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDBSubnetGroupRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable