Class CfnSubnetGroup

Creates a cache subnet group.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnSubnetGroup

Implements

IInspectable

ISubnetGroupRef

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.CfnPropertyName(string)

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.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ElastiCache

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSubnetGroup : CfnResource, IInspectable, ISubnetGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnSubnetGroup Inherits CfnResource Implements IInspectable, ISubnetGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

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

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CacheSubnetGroupName	The name for the cache subnet group.
CfnProperties	Creates a cache subnet group.
CfnPropertyNames	Creates a cache subnet group.
Description	The description for the cache subnet group.
SubnetGroupRef	A reference to a SubnetGroup resource.
SubnetIds	The EC2 subnet IDs for the cache subnet group.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A tag that can be added to an ElastiCache subnet group.

Methods

ArnForSubnetGroup(ISubnetGroupRef)	Creates a cache subnet group.
FromCacheSubnetGroupName(Construct, string, string)	Creates a new ISubnetGroupRef from a cacheSubnetGroupName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnSubnetGroup(object)	Checks whether the given object is a CfnSubnetGroup.
RenderProperties(IDictionary<string, object>)	Creates a cache subnet group.

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 string

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

props ICfnSubnetGroupProps

Resource properties.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

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

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

CacheSubnetGroupName

The name for the cache subnet group.

public virtual string? CacheSubnetGroupName { get; set; }

Property Value

string

Remarks

This value is stored as a lowercase string.

CfnProperties

Creates a cache subnet group.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a cache subnet group.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

Description

The description for the cache subnet group.

public virtual string Description { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

SubnetGroupRef

A reference to a SubnetGroup resource.

public virtual ISubnetGroupReference SubnetGroupRef { get; }

Property Value

ISubnetGroupReference

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

SubnetIds

The EC2 subnet IDs for the cache subnet group.

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

Property Value

string[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

TagsRaw

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

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

Property Value

ICfnTag[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

Methods

ArnForSubnetGroup(ISubnetGroupRef)

Creates a cache subnet group.

public static string ArnForSubnetGroup(ISubnetGroupRef resource)

Parameters

resource ISubnetGroupRef

Returns

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::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.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"
                 } }
             });

FromCacheSubnetGroupName(Construct, string, string)

Creates a new ISubnetGroupRef from a cacheSubnetGroupName.

public static ISubnetGroupRef FromCacheSubnetGroupName(Construct scope, string id, string cacheSubnetGroupName)

Parameters

scope Construct

id string

cacheSubnetGroupName string

Returns

ISubnetGroupRef

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

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

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

IsCfnSubnetGroup(object)

Checks whether the given object is a CfnSubnetGroup.

public static bool IsCfnSubnetGroup(object x)

Parameters

x object

Returns

bool

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a cache 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

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html

CloudformationResource: AWS::ElastiCache::SubnetGroup

ExampleMetadata: fixture=_generated

Implements

IInspectable

ISubnetGroupRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable