software.amazon.awscdk.services.elasticache

Class CfnSubnetGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticache.CfnSubnetGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.011Z")
 @Stability(value=Stable)
public class CfnSubnetGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElastiCache::SubnetGroup`.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 CfnSubnetGroup cfnSubnetGroup = CfnSubnetGroup.Builder.create(this, "MyCfnSubnetGroup")
         .description("description")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .cacheSubnetGroupName("cacheSubnetGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSubnetGroup.Builder A fluent builder for CfnSubnetGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSubnetGroup(software.constructs.Construct scope, String id, CfnSubnetGroupProps props) Create a new `AWS::ElastiCache::SubnetGroup`.
protected	CfnSubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getCacheSubnetGroupName() The name for the cache subnet group.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description for the cache subnet group.
List<String>	getSubnetIds() The EC2 subnet IDs for the cache subnet group.
TagManager	getTags() A tag that can be added to an ElastiCache subnet group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCacheSubnetGroupName(String value) The name for the cache subnet group.
void	setDescription(String value) The description for the cache subnet group.
void	setSubnetIds(List<String> value) The EC2 subnet IDs for the cache subnet group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSubnetGroup

protected CfnSubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnSubnetGroup

protected CfnSubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSubnetGroup

@Stability(value=Stable)
public CfnSubnetGroup(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnSubnetGroupProps props)

Create a new `AWS::ElastiCache::SubnetGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

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.

getDescription

@Stability(value=Stable)
 @NotNull
public String getDescription()

The description for the cache subnet group.

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

The description for the cache subnet group.

getSubnetIds

@Stability(value=Stable)
 @NotNull
public List<String> getSubnetIds()

The EC2 subnet IDs for the cache subnet group.

setSubnetIds

@Stability(value=Stable)
public void setSubnetIds(@NotNull
                                                  List<String> value)

The EC2 subnet IDs for the cache subnet group.

getCacheSubnetGroupName

@Stability(value=Stable)
 @Nullable
public String getCacheSubnetGroupName()

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

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

Example: mysubnetgroup

setCacheSubnetGroupName

@Stability(value=Stable)
public void setCacheSubnetGroupName(@Nullable
                                                             String value)

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

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

Example: mysubnetgroup