Package software.amazon.awscdk.services.elasticache

Interface CfnSubnetGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSubnetGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:05.746Z")
@Stability(Stable)
public interface CfnSubnetGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSubnetGroup.

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.*;
 CfnSubnetGroupProps cfnSubnetGroupProps = CfnSubnetGroupProps.builder()
         .description("description")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .cacheSubnetGroupName("cacheSubnetGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSubnetGroupProps.Builder	A builder for CfnSubnetGroupProps
static final class	CfnSubnetGroupProps.Jsii$Proxy	An implementation for CfnSubnetGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnSubnetGroupProps.Builder	builder()
default String	getCacheSubnetGroupName()	The name for the cache subnet group.
String	getDescription()	The description for the cache subnet group.
List<String>	getSubnetIds()	The EC2 subnet IDs for the cache subnet group.
default List<CfnTag>	getTags()	A tag that can be added to an ElastiCache subnet group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

The description for the cache subnet group.

See Also:

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

getSubnetIds

@Stability(Stable)
@NotNull
List<String> getSubnetIds()

The EC2 subnet IDs for the cache subnet group.

See Also:

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

getCacheSubnetGroupName

@Stability(Stable)
@Nullable
default 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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

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

builder

@Stability(Stable)
static CfnSubnetGroupProps.Builder builder()

Returns:

a CfnSubnetGroupProps.Builder of CfnSubnetGroupProps