Package software.amazon.awscdk.services.elasticache

Class CfnSubnetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.506Z") @Stability(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();

  • 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 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 Details

    • 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

    • getTags

      @Stability(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(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.

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

      Example: mysubnetgroup

    • setCacheSubnetGroupName

      @Stability(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