Class CfnSubnetGroup

A CloudFormation AWS::ElastiCache::SubnetGroup.

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

Creates a cache subnet group. For more information about cache subnet groups, go to Cache Subnet Groups in the Amazon ElastiCache User Guide or go to CreateCacheSubnetGroup in the Amazon ElastiCache API Reference Guide .

CloudformationResource: AWS::ElastiCache::SubnetGroup

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.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.ElastiCache;

var cfnSubnetGroup = new CfnSubnetGroup(this, "MyCfnSubnetGroup", new CfnSubnetGroupProps {
    Description = "description",
    SubnetIds = new [] { "subnetIds" },

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

Synopsis

Constructors

CfnSubnetGroup(Construct, String, ICfnSubnetGroupProps)

Create a new AWS::ElastiCache::SubnetGroup.
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

Properties

CacheSubnetGroupName

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

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

The description for the cache subnet group.
SubnetIds

The EC2 subnet IDs for the cache subnet group.
Tags

A tag that can be added to an ElastiCache subnet group.

Methods

Inspect(TreeInspector)

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

Constructors

CfnSubnetGroup(Construct, String, ICfnSubnetGroupProps)

Create a new AWS::ElastiCache::SubnetGroup.

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

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

Properties

CacheSubnetGroupName

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

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

System.String

Remarks

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-cachesubnetgroupname

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

The description for the cache subnet group.

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

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-description

SubnetIds

The EC2 subnet IDs for the cache subnet group.

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

System.String[]

Remarks

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

Tags

A tag that can be added to an ElastiCache subnet group.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-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