Package software.amazon.awscdk.services.elasticache

Class CfnServerlessCacheSnapshot

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.CfnServerlessCacheSnapshot
All Implemented Interfaces:
IInspectable, IServerlessCacheSnapshotRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:10.034Z") @Stability(Stable) public class CfnServerlessCacheSnapshot extends CfnResource implements IInspectable, IServerlessCacheSnapshotRef, ITaggableV2
Resource Type definition for AWS::ElastiCache::ServerlessCacheSnapshot.

A serverless cache snapshot is a point-in-time backup of an ElastiCache serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

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.*;
 CfnServerlessCacheSnapshot cfnServerlessCacheSnapshot = CfnServerlessCacheSnapshot.Builder.create(this, "MyCfnServerlessCacheSnapshot")
         .serverlessCacheName("serverlessCacheName")
         .serverlessCacheSnapshotName("serverlessCacheSnapshotName")
         // the properties below are optional
         .kmsKeyId("kmsKeyId")
         .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

    • CfnServerlessCacheSnapshot

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

    • CfnServerlessCacheSnapshot

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

    • CfnServerlessCacheSnapshot

      @Stability(Stable) public CfnServerlessCacheSnapshot(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnServerlessCacheSnapshotProps props)
      Create a new AWS::ElastiCache::ServerlessCacheSnapshot.

      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

    • arnForServerlessCacheSnapshot

      @Stability(Stable) @NotNull public static String arnForServerlessCacheSnapshot(@NotNull IServerlessCacheSnapshotRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnServerlessCacheSnapshot

      @Stability(Stable) @NotNull public static Boolean isCfnServerlessCacheSnapshot(@NotNull Object x)
      Checks whether the given object is a CfnServerlessCacheSnapshot.

      Parameters:
      x - 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the serverless cache snapshot.

    • getAttrBytesUsedForCache

      @Stability(Stable) @NotNull public String getAttrBytesUsedForCache()
      The total size of the serverless cache snapshot, in bytes.

    • getAttrCreateTime

      @Stability(Stable) @NotNull public String getAttrCreateTime()
      The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot.

    • getAttrServerlessCacheConfiguration

      @Stability(Stable) @NotNull public IResolvable getAttrServerlessCacheConfiguration()

    • getAttrSnapshotType

      @Stability(Stable) @NotNull public String getAttrSnapshotType()
      The type of snapshot of the serverless cache.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the serverless cache snapshot.

    • getCdkTagManager

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getServerlessCacheSnapshotRef

      @Stability(Stable) @NotNull public ServerlessCacheSnapshotReference getServerlessCacheSnapshotRef()
      A reference to a ServerlessCacheSnapshot resource.
      Specified by:
      getServerlessCacheSnapshotRef in interface IServerlessCacheSnapshotRef

    • getServerlessCacheName

      @Stability(Stable) @NotNull public String getServerlessCacheName()
      The name of an existing serverless cache.

    • setServerlessCacheName

      @Stability(Stable) public void setServerlessCacheName(@NotNull String value)
      The name of an existing serverless cache.

    • getServerlessCacheSnapshotName

      @Stability(Stable) @NotNull public String getServerlessCacheSnapshotName()
      The name of the serverless cache snapshot.

    • setServerlessCacheSnapshotName

      @Stability(Stable) public void setServerlessCacheSnapshotName(@NotNull String value)
      The name of the serverless cache snapshot.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the snapshot.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the snapshot.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags to be added to the serverless cache snapshot resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags to be added to the serverless cache snapshot resource.