2.219.0

interface IServerlessCache 🔹

LanguageType name
.NETAmazon.CDK.AWS.ElastiCache.Alpha.IServerlessCache
Gogithub.com/aws/aws-cdk-go/awscdkelasticachealpha/v2#IServerlessCache
Javasoftware.amazon.awscdk.services.elasticache.alpha.IServerlessCache
Pythonaws_cdk.aws_elasticache_alpha.IServerlessCache
TypeScript (source)@aws-cdk/aws-elasticache-alpha » IServerlessCache

Implemented by ServerlessCache

Obtainable from ServerlessCache.fromServerlessCacheArn(), ServerlessCache.fromServerlessCacheAttributes(), ServerlessCache.fromServerlessCacheName()

Represents a Serverless ElastiCache cache.

Properties

NameTypeDescription
connections🔹ConnectionsThe network connections associated with this resource.
env🔹ResourceEnvironmentThe environment this resource belongs to.
node🔹NodeThe tree node.
serverlessCacheArn🔹stringThe ARN of the serverless cache.
serverlessCacheName🔹stringThe name of the serverless cache.
stack🔹StackThe stack in which this resource is defined.
backupArnsToRestore?🔹string[]The ARNs of backups restored in the cache.
engine?🔹CacheEngineThe cache engine used by this cache.
kmsKey?🔹IKeyThe KMS key used for encryption.
securityGroups?🔹ISecurityGroup[]The security groups associated with this cache.
subnets?🔹ISubnet[]The subnets this cache is deployed in.
userGroup?🔹IUserGroupThe user group associated with this cache.
vpc?🔹IVpcThe VPC this cache is deployed in.

connections🔹

Type: Connections

The network connections associated with this resource.

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node🔹

Type: Node

The tree node.

serverlessCacheArn🔹

Type: string

The ARN of the serverless cache.

serverlessCacheName🔹

Type: string

The name of the serverless cache.

stack🔹

Type: Stack

The stack in which this resource is defined.

backupArnsToRestore?🔹

Type: string[] (optional)

The ARNs of backups restored in the cache.

engine?🔹

Type: CacheEngine (optional)

The cache engine used by this cache.

kmsKey?🔹

Type: IKey (optional)

The KMS key used for encryption.

securityGroups?🔹

Type: ISecurityGroup[] (optional)

The security groups associated with this cache.

subnets?🔹

Type: ISubnet[] (optional)

The subnets this cache is deployed in.

userGroup?🔹

Type: IUserGroup (optional)

The user group associated with this cache.

vpc?🔹

Type: IVpc (optional)

The VPC this cache is deployed in.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹Grant the given identity custom permissions.
grantConnect(grantee)🔹Grant connect permissions to the cache.
metric(metricName, props?)🔹Return the given named metric for this cache.
metricActiveConnections(props?)🔹Metric for active connections.
metricCacheHitCount(props?)🔹Metric for cache hit count.
metricCacheHitRate(props?)🔹Metric for cache hit rate.
metricCacheMissCount(props?)🔹Metric for cache miss count.
metricDataStored(props?)🔹Metric for data stored in the cache.
metricNetworkBytesIn(props?)🔹Metric for network bytes in.
metricNetworkBytesOut(props?)🔹Metric for network bytes out.
metricProcessingUnitsConsumed(props?)🔹Metric for ECPUs consumed.
metricReadRequestLatency(props?)🔹Metric for read request latency.
metricWriteRequestLatency(props?)🔹Metric for write request latency.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

Returns

Grant the given identity custom permissions.

grantConnect(grantee)🔹

public grantConnect(grantee: IGrantable): Grant

Parameters

Returns

Grant connect permissions to the cache.

metric(metricName, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

Returns

Return the given named metric for this cache.

metricActiveConnections(props?)🔹

public metricActiveConnections(props?: MetricOptions): Metric

Parameters

Returns

Metric for active connections.

metricCacheHitCount(props?)🔹

public metricCacheHitCount(props?: MetricOptions): Metric

Parameters

Returns

Metric for cache hit count.

metricCacheHitRate(props?)🔹

public metricCacheHitRate(props?: MetricOptions): Metric

Parameters

Returns

Metric for cache hit rate.

metricCacheMissCount(props?)🔹

public metricCacheMissCount(props?: MetricOptions): Metric

Parameters

Returns

Metric for cache miss count.

metricDataStored(props?)🔹

public metricDataStored(props?: MetricOptions): Metric

Parameters

Returns

Metric for data stored in the cache.

metricNetworkBytesIn(props?)🔹

public metricNetworkBytesIn(props?: MetricOptions): Metric

Parameters

Returns

Metric for network bytes in.

metricNetworkBytesOut(props?)🔹

public metricNetworkBytesOut(props?: MetricOptions): Metric

Parameters

Returns

Metric for network bytes out.

metricProcessingUnitsConsumed(props?)🔹

public metricProcessingUnitsConsumed(props?: MetricOptions): Metric

Parameters

Returns

Metric for ECPUs consumed.

metricReadRequestLatency(props?)🔹

public metricReadRequestLatency(props?: MetricOptions): Metric

Parameters

Returns

Metric for read request latency.

metricWriteRequestLatency(props?)🔹

public metricWriteRequestLatency(props?: MetricOptions): Metric

Parameters

Returns

Metric for write request latency.

← PreviousNext →