@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.986Z") public class CfnSubnetGroup extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnSubnetGroup.Builder
A fluent builder for
CfnSubnetGroup . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnSubnetGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnSubnetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnSubnetGroup(Construct scope, java.lang.String id, CfnSubnetGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
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.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.util.List<java.lang.String> getSubnetIds()
public void setSubnetIds(java.util.List<java.lang.String> value)
public java.lang.String getCacheSubnetGroupName()
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
public void setCacheSubnetGroupName(java.lang.String value)
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup