Class CfnSubnetGroup
Specifies a subnet group.
Inherited Members
Namespace: Amazon.CDK.AWS.MemoryDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSubnetGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnSubnetGroup
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A subnet group is a collection of subnets (typically private) that you can designate for your cluster s running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC , you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html
CloudformationResource: AWS::MemoryDB::SubnetGroup
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.MemoryDB;
var cfnSubnetGroup = new CfnSubnetGroup(this, "MyCfnSubnetGroup", new CfnSubnetGroupProps {
SubnetGroupName = "subnetGroupName",
SubnetIds = new [] { "subnetIds" },
// the properties below are optional
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnSubnetGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSubnetGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSubnetGroup(Construct, String, ICfnSubnetGroupProps) |
Properties
AttrArn | When you pass the logical ID of this resource to the intrinsic |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the subnet group. |
SubnetGroupName | The name of the subnet group to be used for the cluster . |
SubnetIds | A list of Amazon VPC subnet IDs for the subnet group. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSubnetGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSubnetGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSubnetGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSubnetGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSubnetGroup(Construct, String, ICfnSubnetGroupProps)
public CfnSubnetGroup(Construct scope, string id, ICfnSubnetGroupProps 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 ICfnSubnetGroupProps
Resource properties.
Properties
AttrArn
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref returns the ARN of the subnet group, such as arn:aws:memorydb:us-east-1:123456789012:subnetgroup/my-subnet-group
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ARN
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
Description
A description of the subnet group.
public virtual string Description { get; set; }
Property Value
System.String
SubnetGroupName
The name of the subnet group to be used for the cluster .
public virtual string SubnetGroupName { get; set; }
Property Value
System.String
SubnetIds
A list of Amazon VPC 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
An array of key-value pairs to apply to this resource.
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>