Package software.amazon.awscdk.services.elasticache.alpha

Interface IServerlessCache

All Superinterfaces:
IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IServerlessCache.Jsii$Default
All Known Implementing Classes:
IServerlessCache.Jsii$Proxy, ServerlessCache, ServerlessCacheBase
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:23.373Z") @Stability(Experimental) public interface IServerlessCache extends software.amazon.jsii.JsiiSerializable, IResource, IConnectable
(experimental) Represents a Serverless ElastiCache cache.

  • Method Details

    • getServerlessCacheArn

      @Stability(Experimental) @NotNull String getServerlessCacheArn()
      (experimental) The ARN of the serverless cache.

    • getServerlessCacheName

      @Stability(Experimental) @NotNull String getServerlessCacheName()
      (experimental) The name of the serverless cache.

    • getBackupArnsToRestore

      @Stability(Experimental) @Nullable default List<String> getBackupArnsToRestore()
      (experimental) The ARNs of backups restored in the cache.

    • getEngine

      @Stability(Experimental) @Nullable default CacheEngine getEngine()
      (experimental) The cache engine used by this cache.

    • getKmsKey

      @Stability(Experimental) @Nullable default IKey getKmsKey()
      (experimental) The KMS key used for encryption.

    • getSecurityGroups

      @Stability(Experimental) @Nullable default List<ISecurityGroup> getSecurityGroups()
      (experimental) The security groups associated with this cache.

    • getSubnets

      @Stability(Experimental) @Nullable default List<ISubnet> getSubnets()
      (experimental) The subnets this cache is deployed in.

    • getUserGroup

      @Stability(Experimental) @Nullable default IUserGroup getUserGroup()
      (experimental) The user group associated with this cache.

    • getVpc

      @Stability(Experimental) @Nullable default IVpc getVpc()
      (experimental) The VPC this cache is deployed in.

    • grant

      @Stability(Experimental) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      (experimental) Grant the given identity custom permissions.

      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantConnect

      @Stability(Experimental) @NotNull Grant grantConnect(@NotNull IGrantable grantee)
      (experimental) Grant connect permissions to the cache.

      Parameters:
      grantee - This parameter is required.

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Return the given named metric for this cache.

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName)
      (experimental) Return the given named metric for this cache.

      Parameters:
      metricName - This parameter is required.

    • metricActiveConnections

      @Stability(Experimental) @NotNull Metric metricActiveConnections(@Nullable MetricOptions props)
      (experimental) Metric for active connections.

      Parameters:
      props -

    • metricActiveConnections

      @Stability(Experimental) @NotNull Metric metricActiveConnections()
      (experimental) Metric for active connections.

    • metricCacheHitCount

      @Stability(Experimental) @NotNull Metric metricCacheHitCount(@Nullable MetricOptions props)
      (experimental) Metric for cache hit count.

      Parameters:
      props -

    • metricCacheHitCount

      @Stability(Experimental) @NotNull Metric metricCacheHitCount()
      (experimental) Metric for cache hit count.

    • metricCacheHitRate

      @Stability(Experimental) @NotNull Metric metricCacheHitRate(@Nullable MetricOptions props)
      (experimental) Metric for cache hit rate.

      Parameters:
      props -

    • metricCacheHitRate

      @Stability(Experimental) @NotNull Metric metricCacheHitRate()
      (experimental) Metric for cache hit rate.

    • metricCacheMissCount

      @Stability(Experimental) @NotNull Metric metricCacheMissCount(@Nullable MetricOptions props)
      (experimental) Metric for cache miss count.

      Parameters:
      props -

    • metricCacheMissCount

      @Stability(Experimental) @NotNull Metric metricCacheMissCount()
      (experimental) Metric for cache miss count.

    • metricDataStored

      @Stability(Experimental) @NotNull Metric metricDataStored(@Nullable MetricOptions props)
      (experimental) Metric for data stored in the cache.

      Parameters:
      props -

    • metricDataStored

      @Stability(Experimental) @NotNull Metric metricDataStored()
      (experimental) Metric for data stored in the cache.

    • metricNetworkBytesIn

      @Stability(Experimental) @NotNull Metric metricNetworkBytesIn(@Nullable MetricOptions props)
      (experimental) Metric for network bytes in.

      Parameters:
      props -

    • metricNetworkBytesIn

      @Stability(Experimental) @NotNull Metric metricNetworkBytesIn()
      (experimental) Metric for network bytes in.

    • metricNetworkBytesOut

      @Stability(Experimental) @NotNull Metric metricNetworkBytesOut(@Nullable MetricOptions props)
      (experimental) Metric for network bytes out.

      Parameters:
      props -

    • metricNetworkBytesOut

      @Stability(Experimental) @NotNull Metric metricNetworkBytesOut()
      (experimental) Metric for network bytes out.

    • metricProcessingUnitsConsumed

      @Stability(Experimental) @NotNull Metric metricProcessingUnitsConsumed(@Nullable MetricOptions props)
      (experimental) Metric for ECPUs consumed.

      Parameters:
      props -

    • metricProcessingUnitsConsumed

      @Stability(Experimental) @NotNull Metric metricProcessingUnitsConsumed()
      (experimental) Metric for ECPUs consumed.

    • metricReadRequestLatency

      @Stability(Experimental) @NotNull Metric metricReadRequestLatency(@Nullable MetricOptions props)
      (experimental) Metric for read request latency.

      Parameters:
      props -

    • metricReadRequestLatency

      @Stability(Experimental) @NotNull Metric metricReadRequestLatency()
      (experimental) Metric for read request latency.

    • metricWriteRequestLatency

      @Stability(Experimental) @NotNull Metric metricWriteRequestLatency(@Nullable MetricOptions props)
      (experimental) Metric for write request latency.

      Parameters:
      props -

    • metricWriteRequestLatency

      @Stability(Experimental) @NotNull Metric metricWriteRequestLatency()
      (experimental) Metric for write request latency.