software.amazon.awscdk.services.elasticache

Class CfnSubnetGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.elasticache.CfnSubnetGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.986Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSubnetGroup(Construct scope, java.lang.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
java.lang.String	getCacheSubnetGroupName() The name for the cache subnet group.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description for the cache subnet group.
java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCacheSubnetGroupName(java.lang.String value) The name for the cache subnet group.
void	setDescription(java.lang.String value) The description for the cache subnet group.
void	setSubnetIds(java.util.List<java.lang.String> value) The EC2 subnet IDs for the cache subnet group.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnSubnetGroup(Construct scope,
                      java.lang.String id,
                      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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

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

public java.lang.String getDescription()

The description for the cache subnet group.

setDescription

public void setDescription(java.lang.String value)

The description for the cache subnet group.

getSubnetIds

public java.util.List<java.lang.String> getSubnetIds()

The EC2 subnet IDs for the cache subnet group.

setSubnetIds

public void setSubnetIds(java.util.List<java.lang.String> value)

The EC2 subnet IDs for the cache subnet group.

getCacheSubnetGroupName

public java.lang.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

public void setCacheSubnetGroupName(java.lang.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