Package 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, ISubnetGroupRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-17T14:40:51.592Z") @Stability(Stable) public class CfnSubnetGroup extends CfnResource implements IInspectable, ISubnetGroupRef, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSubnetGroup

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

    • CfnSubnetGroup

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

    • CfnSubnetGroup

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromCacheSubnetGroupName

      @Stability(Stable) @NotNull public static ISubnetGroupRef fromCacheSubnetGroupName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String cacheSubnetGroupName)
      Creates a new ISubnetGroupRef from a cacheSubnetGroupName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      cacheSubnetGroupName - This parameter is required.

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSubnetGroupRef

      @Stability(Stable) @NotNull public SubnetGroupReference getSubnetGroupRef()
      A reference to a SubnetGroup resource.
      Specified by:
      getSubnetGroupRef in interface ISubnetGroupRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      The description for the cache subnet group.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      The description for the cache subnet group.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      The EC2 subnet IDs for the cache subnet group.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      The EC2 subnet IDs for the cache subnet group.

    • getCacheSubnetGroupName

      @Stability(Stable) @Nullable public String getCacheSubnetGroupName()
      The name for the cache subnet group.

      This value is stored as a lowercase string.

    • setCacheSubnetGroupName

      @Stability(Stable) public void setCacheSubnetGroupName(@Nullable String value)
      The name for the cache subnet group.

      This value is stored as a lowercase string.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A tag that can be added to an ElastiCache subnet group.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A tag that can be added to an ElastiCache subnet group.