Class CfnDBSubnetGroup
The AWS::DocDB::DBSubnetGroup
Amazon DocumentDB (with MongoDB compatibility) resource describes a DBSubnetGroup.
Inherited Members
Namespace: Amazon.CDK.AWS.DocDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBSubnetGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDBSubnetGroup
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region . For more information, see DBSubnetGroup in the Amazon DocumentDB Developer Guide .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html
CloudformationResource: AWS::DocDB::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.DocDB;
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(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 |
CfnDBSubnetGroup(Construct, String, ICfnDBSubnetGroupProps) |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DbSubnetGroupDescription | The description for the subnet group. |
DbSubnetGroupName | The name for the subnet group. |
SubnetIds | The Amazon EC2 subnet IDs for the subnet group. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags to be assigned to the subnet group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnDBSubnetGroup(Construct, String, ICfnDBSubnetGroupProps)
public CfnDBSubnetGroup(Construct scope, string id, ICfnDBSubnetGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDBSubnetGroupProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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 subnet group.
public virtual string DbSubnetGroupDescription { get; set; }
Property Value
System.String
DbSubnetGroupName
The name for the subnet group.
public virtual string DbSubnetGroupName { get; set; }
Property Value
System.String
Remarks
This value is stored as a lowercase string.
SubnetIds
The Amazon EC2 subnet IDs for the subnet group.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags to be assigned to the subnet group.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>