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

Class ServerlessCacheBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.elasticache.alpha.ServerlessCacheBase

All Implemented Interfaces:

IResource, IConnectable, IServerlessCache, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

ServerlessCache

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-01T17:47:05.836Z")
@Stability(Experimental)
public abstract class ServerlessCacheBase
extends Resource
implements IServerlessCache

(experimental) Base class for ServerlessCache constructs.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticache.alpha.IServerlessCache

IServerlessCache.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServerlessCacheBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ServerlessCacheBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	ServerlessCacheBase(software.constructs.Construct scope, String id)
protected	ServerlessCacheBase(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
abstract List<String>	getBackupArnsToRestore()	(experimental) The ARNs of backups restored in the cache.
abstract Connections	getConnections()	(experimental) Access to network connections.
abstract CacheEngine	getEngine()	(experimental) The cache engine used by this cache.
abstract IKey	getKmsKey()	(experimental) The KMS key used for encryption.
abstract List<ISecurityGroup>	getSecurityGroups()	(experimental) The security groups associated with this cache.
abstract String	getServerlessCacheArn()	(experimental) The ARN of the serverless cache.
abstract String	getServerlessCacheName()	(experimental) The name of the serverless cache.
abstract List<ISubnet>	getSubnets()	(experimental) The subnets this cache is deployed in.
abstract IUserGroup	getUserGroup()	(experimental) The user group associated with this cache.
abstract IVpc	getVpc()	(experimental) The VPC this cache is deployed in.
Grant	grant(IGrantable grantee, String... actions)	(experimental) Grant the given identity custom permissions.
Grant	grantConnect(IGrantable grantee)	(experimental) Grant connect permissions to the cache.
Metric	metric(String metricName)	(experimental) Return the given named metric for this cache.
Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric for this cache.
Metric	metricActiveConnections()	(experimental) Metric for active connections.
Metric	metricActiveConnections(MetricOptions props)	(experimental) Metric for active connections.
Metric	metricCacheHitCount()	(experimental) Metric for cache hit count.
Metric	metricCacheHitCount(MetricOptions props)	(experimental) Metric for cache hit count.
Metric	metricCacheHitRate()	(experimental) Metric for cache hit rate.
Metric	metricCacheHitRate(MetricOptions props)	(experimental) Metric for cache hit rate.
Metric	metricCacheMissCount()	(experimental) Metric for cache miss count.
Metric	metricCacheMissCount(MetricOptions props)	(experimental) Metric for cache miss count.
Metric	metricDataStored()	(experimental) Metric for data stored in the cache.
Metric	metricDataStored(MetricOptions props)	(experimental) Metric for data stored in the cache.
Metric	metricNetworkBytesIn()	(experimental) Metric for network bytes in.
Metric	metricNetworkBytesIn(MetricOptions props)	(experimental) Metric for network bytes in.
Metric	metricNetworkBytesOut()	(experimental) Metric for network bytes out.
Metric	metricNetworkBytesOut(MetricOptions props)	(experimental) Metric for network bytes out.
Metric	metricProcessingUnitsConsumed()	(experimental) Metric for ECPUs consumed.
Metric	metricProcessingUnitsConsumed(MetricOptions props)	(experimental) Metric for ECPUs consumed.
Metric	metricReadRequestLatency()	(experimental) Metric for read request latency.
Metric	metricReadRequestLatency(MetricOptions props)	(experimental) Metric for read request latency.
Metric	metricWriteRequestLatency()	(experimental) Metric for write request latency.
Metric	metricWriteRequestLatency(MetricOptions props)	(experimental) Metric for write request latency.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ServerlessCacheBase

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

ServerlessCacheBase

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

ServerlessCacheBase

@Stability(Stable)
protected ServerlessCacheBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ServerlessCacheBase

@Stability(Stable)
protected ServerlessCacheBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

(experimental) Grant the given identity custom permissions.

Specified by:

grant in interface IServerlessCache

Parameters:

grantee - The principal to grant permissions to. This parameter is required.

actions - The actions to grant. This parameter is required.

grantConnect

@Stability(Experimental)
@NotNull
public Grant grantConnect(@NotNull
 IGrantable grantee)

(experimental) Grant connect permissions to the cache.

Specified by:

grantConnect in interface IServerlessCache

Parameters:

grantee - The principal to grant permissions to. This parameter is required.

metric

@Stability(Experimental)
@NotNull
public Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

(experimental) Return the given named metric for this cache.

Default: Average over 5 minutes

Specified by:

metric in interface IServerlessCache

Parameters:

metricName - The name of the metric. This parameter is required.

props - Additional properties which will be merged with the default metric.

metric

@Stability(Experimental)
@NotNull
public Metric metric(@NotNull
 String metricName)

(experimental) Return the given named metric for this cache.

Default: Average over 5 minutes

Specified by:

metric in interface IServerlessCache

Parameters:

metricName - The name of the metric. This parameter is required.

metricActiveConnections

@Stability(Experimental)
@NotNull
public Metric metricActiveConnections(@Nullable
 MetricOptions props)

(experimental) Metric for active connections.

Default: Maximum over 5 minutes

Specified by:

metricActiveConnections in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricActiveConnections

@Stability(Experimental)
@NotNull
public Metric metricActiveConnections()

(experimental) Metric for active connections.

Default: Maximum over 5 minutes

Specified by:

metricActiveConnections in interface IServerlessCache

metricCacheHitCount

@Stability(Experimental)
@NotNull
public Metric metricCacheHitCount(@Nullable
 MetricOptions props)

(experimental) Metric for cache hit count.

Default: Sum over 5 minutes

Specified by:

metricCacheHitCount in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricCacheHitCount

@Stability(Experimental)
@NotNull
public Metric metricCacheHitCount()

(experimental) Metric for cache hit count.

Default: Sum over 5 minutes

Specified by:

metricCacheHitCount in interface IServerlessCache

metricCacheHitRate

@Stability(Experimental)
@NotNull
public Metric metricCacheHitRate(@Nullable
 MetricOptions props)

(experimental) Metric for cache hit rate.

Default: Average over 5 minutes

Specified by:

metricCacheHitRate in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricCacheHitRate

@Stability(Experimental)
@NotNull
public Metric metricCacheHitRate()

(experimental) Metric for cache hit rate.

Default: Average over 5 minutes

Specified by:

metricCacheHitRate in interface IServerlessCache

metricCacheMissCount

@Stability(Experimental)
@NotNull
public Metric metricCacheMissCount(@Nullable
 MetricOptions props)

(experimental) Metric for cache miss count.

Default: Sum over 5 minutes

Specified by:

metricCacheMissCount in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricCacheMissCount

@Stability(Experimental)
@NotNull
public Metric metricCacheMissCount()

(experimental) Metric for cache miss count.

Default: Sum over 5 minutes

Specified by:

metricCacheMissCount in interface IServerlessCache

metricDataStored

@Stability(Experimental)
@NotNull
public Metric metricDataStored(@Nullable
 MetricOptions props)

(experimental) Metric for data stored in the cache.

Default: Maximum over 5 minutes

Specified by:

metricDataStored in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricDataStored

@Stability(Experimental)
@NotNull
public Metric metricDataStored()

(experimental) Metric for data stored in the cache.

Default: Maximum over 5 minutes

Specified by:

metricDataStored in interface IServerlessCache

metricNetworkBytesIn

@Stability(Experimental)
@NotNull
public Metric metricNetworkBytesIn(@Nullable
 MetricOptions props)

(experimental) Metric for network bytes in.

Default: Sum over 5 minutes

Specified by:

metricNetworkBytesIn in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricNetworkBytesIn

@Stability(Experimental)
@NotNull
public Metric metricNetworkBytesIn()

(experimental) Metric for network bytes in.

Default: Sum over 5 minutes

Specified by:

metricNetworkBytesIn in interface IServerlessCache

metricNetworkBytesOut

@Stability(Experimental)
@NotNull
public Metric metricNetworkBytesOut(@Nullable
 MetricOptions props)

(experimental) Metric for network bytes out.

Default: Sum over 5 minutes

Specified by:

metricNetworkBytesOut in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricNetworkBytesOut

@Stability(Experimental)
@NotNull
public Metric metricNetworkBytesOut()

(experimental) Metric for network bytes out.

Default: Sum over 5 minutes

Specified by:

metricNetworkBytesOut in interface IServerlessCache

metricProcessingUnitsConsumed

@Stability(Experimental)
@NotNull
public Metric metricProcessingUnitsConsumed(@Nullable
 MetricOptions props)

(experimental) Metric for ECPUs consumed.

Default: Average over 5 minutes

Specified by:

metricProcessingUnitsConsumed in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricProcessingUnitsConsumed

@Stability(Experimental)
@NotNull
public Metric metricProcessingUnitsConsumed()

(experimental) Metric for ECPUs consumed.

Default: Average over 5 minutes

Specified by:

metricProcessingUnitsConsumed in interface IServerlessCache

metricReadRequestLatency

@Stability(Experimental)
@NotNull
public Metric metricReadRequestLatency(@Nullable
 MetricOptions props)

(experimental) Metric for read request latency.

Default: Average over 5 minutes

Specified by:

metricReadRequestLatency in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricReadRequestLatency

@Stability(Experimental)
@NotNull
public Metric metricReadRequestLatency()

(experimental) Metric for read request latency.

Default: Average over 5 minutes

Specified by:

metricReadRequestLatency in interface IServerlessCache

metricWriteRequestLatency

@Stability(Experimental)
@NotNull
public Metric metricWriteRequestLatency(@Nullable
 MetricOptions props)

(experimental) Metric for write request latency.

Default: Average over 5 minutes

Specified by:

metricWriteRequestLatency in interface IServerlessCache

Parameters:

props - Additional properties which will be merged with the default metric.

metricWriteRequestLatency

@Stability(Experimental)
@NotNull
public Metric metricWriteRequestLatency()

(experimental) Metric for write request latency.

Default: Average over 5 minutes

Specified by:

metricWriteRequestLatency in interface IServerlessCache

getConnections

@Stability(Experimental)
@NotNull
public abstract Connections getConnections()

(experimental) Access to network connections.

Specified by:

getConnections in interface IConnectable

getServerlessCacheArn

@Stability(Experimental)
@NotNull
public abstract String getServerlessCacheArn()

(experimental) The ARN of the serverless cache.

Specified by:

getServerlessCacheArn in interface IServerlessCache

getServerlessCacheName

@Stability(Experimental)
@NotNull
public abstract String getServerlessCacheName()

(experimental) The name of the serverless cache.

Specified by:

getServerlessCacheName in interface IServerlessCache

getBackupArnsToRestore

@Stability(Experimental)
@Nullable
public abstract List<String> getBackupArnsToRestore()

(experimental) The ARNs of backups restored in the cache.

Specified by:

getBackupArnsToRestore in interface IServerlessCache

getEngine

@Stability(Experimental)
@Nullable
public abstract CacheEngine getEngine()

(experimental) The cache engine used by this cache.

Specified by:

getEngine in interface IServerlessCache

getKmsKey

@Stability(Experimental)
@Nullable
public abstract IKey getKmsKey()

(experimental) The KMS key used for encryption.

Specified by:

getKmsKey in interface IServerlessCache

getSecurityGroups

@Stability(Experimental)
@Nullable
public abstract List<ISecurityGroup> getSecurityGroups()

(experimental) The security groups associated with this cache.

Specified by:

getSecurityGroups in interface IServerlessCache

getSubnets

@Stability(Experimental)
@Nullable
public abstract List<ISubnet> getSubnets()

(experimental) The subnets this cache is deployed in.

Specified by:

getSubnets in interface IServerlessCache

getUserGroup

@Stability(Experimental)
@Nullable
public abstract IUserGroup getUserGroup()

(experimental) The user group associated with this cache.

Specified by:

getUserGroup in interface IServerlessCache

getVpc

@Stability(Experimental)
@Nullable
public abstract IVpc getVpc()

(experimental) The VPC this cache is deployed in.

Specified by:

getVpc in interface IServerlessCache