> **Experimental**
>
> `@aws-cdk/aws-elasticache-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# ServerlessCacheBase

Base class for ServerlessCache constructs.

Extends: Construct › Resource › ServerlessCacheBase
Implements: IServerlessCache, IResource, IConnectable, IEnvironmentAware, IServerlessCacheRef, IConstruct, IDependable
Superclass of: ServerlessCache

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/serverless-cache-base.ts`](https://github.com/aws/aws-cdk/blob/v2.273.0-alpha.0/packages/@aws-cdk/aws-elasticache-alpha/lib/serverless-cache-base.ts#L210)

## Initializer

```ts
new ServerlessCacheBase(scope: Construct, id: string, props?: ResourceProps)
```

## Construct Props

- `account`: string = the resource is in the same account as the stack it belongs to — The AWS account ID this resource belongs to.

  **Default:** the resource is in the same account as the stack it belongs to

- `environmentFromArn`: string = take environment from `account`, `region` parameters, or use Stack environment. — ARN to deduce region and account from.

  The ARN is parsed and the account and region are taken from the ARN.
  This should be used for imported resources.

  Cannot be supplied together with either `account` or `region`.

  **Default:** take environment from `account`, `region` parameters, or use Stack environment.

- `physicalName`: string = The physical name will be allocated by CloudFormation at deployment time — The value passed in by users to the physical name prop of the resource.

  - `undefined` implies that a physical name will be allocated by
    CloudFormation during deployment.
  - a concrete value implies a specific physical name
  - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
    by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

  **Default:** The physical name will be allocated by CloudFormation at deployment time

- `region`: string = the resource is in the same region as the stack it belongs to — The AWS region this resource belongs to.

  **Default:** the resource is in the same region as the stack it belongs to

## Properties

- `backupArnsToRestore`: string[] — The ARNs of backups restored in the cache.

- `connections`: [Connections](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Connections.html) (required) — Access to network connections.

- `engine`: [CacheEngine](/cdk/api/v2/docs/@aws-cdk_aws-elasticache-alpha.CacheEngine.html) — The cache engine used by this cache.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `grants`: [ServerlessCacheGrants](/cdk/api/v2/docs/@aws-cdk_aws-elasticache-alpha.ServerlessCacheGrants.html) (required) — Collection of grant methods for this cache.

- `kmsKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The KMS key used for encryption.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] — The security groups associated with this cache.

- `serverlessCacheArn`: string (required) — The ARN of the serverless cache.

- `serverlessCacheName`: string (required) — The name of the serverless cache.

- `serverlessCacheRef`: [ServerlessCacheReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_elasticache.ServerlessCacheReference.html) (required) — A reference to a ServerlessCache resource.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

- `subnets`: [ISubnet](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISubnet.html)[] — The subnets this cache is deployed in.

- `userGroup`: [IUserGroup](/cdk/api/v2/docs/@aws-cdk_aws-elasticache-alpha.IUserGroup.html) — The user group associated with this cache.

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) — The VPC this cache is deployed in.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — 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: IGrantable, ...actions: string[]): Grant` — Grant the given identity custom permissions [disable-awslint:no-grants].

  **Parameters**

  - `grantee` — The principal to grant permissions to.
  - `actions` — The actions to grant.

- `grantConnect(grantee: IGrantable): Grant` — Grant connect permissions to the cache [disable-awslint:no-grants].

  **Parameters**

  - `grantee` — The principal to grant permissions to.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this cache.

  **Parameters**

  - `metricName` — The name of the metric.
  - `props` — Additional properties which will be merged with the default metric.

- `metricActiveConnections(props?: MetricOptions): Metric` — Metric for active connections.

  **Parameters**

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

- `metricCacheHitCount(props?: MetricOptions): Metric` — Metric for cache hit count.

  **Parameters**

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

- `metricCacheHitRate(props?: MetricOptions): Metric` — Metric for cache hit rate.

  **Parameters**

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

- `metricCacheMissCount(props?: MetricOptions): Metric` — Metric for cache miss count.

  **Parameters**

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

- `metricDataStored(props?: MetricOptions): Metric` — Metric for data stored in the cache.

  **Parameters**

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

- `metricNetworkBytesIn(props?: MetricOptions): Metric` — Metric for network bytes in.

  **Parameters**

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

- `metricNetworkBytesOut(props?: MetricOptions): Metric` — Metric for network bytes out.

  **Parameters**

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

- `metricProcessingUnitsConsumed(props?: MetricOptions): Metric` — Metric for ECPUs consumed.

  **Parameters**

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

- `metricReadRequestLatency(props?: MetricOptions): Metric` — Metric for read request latency.

  **Parameters**

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

- `metricWriteRequestLatency(props?: MetricOptions): Metric` — Metric for write request latency.

  **Parameters**

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

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.