AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ElastiCache::ServerlessCache

CfnServerlessCache

The resource representing a serverless cache.

Import

import { CfnServerlessCache } from 'aws-cdk-lib/aws-elasticache';

Or use the module namespace:

import * as elasticache from 'aws-cdk-lib/aws-elasticache';
// elasticache.CfnServerlessCache

Properties

Configuration passed to the constructor as CfnServerlessCacheProps.

engineRequired
string

The engine the serverless cache is compatible with.

serverlessCacheNameRequired
string

The unique identifier of the serverless cache.

cacheUsageLimitsOptional
IResolvable | CacheUsageLimitsProperty

The cache usage limit for the serverless cache.

dailySnapshotTimeOptional
string

The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

descriptionOptional
string

A description of the serverless cache.

endpointOptional
IResolvable | EndpointProperty

Represents the information required for client programs to connect to a cache node. This value is read-only.

finalSnapshotNameOptional
string

The name of the final snapshot taken of a cache before the cache is deleted.

kmsKeyIdOptional
string | IKeyRef

The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

majorEngineVersionOptional
string

The version number of the engine the serverless cache is compatible with.

readerEndpointOptional
IResolvable | EndpointProperty

Represents the information required for client programs to connect to a cache node. This value is read-only.

securityGroupIdsOptional
string | ISecurityGroupRef[]

The IDs of the EC2 security groups associated with the serverless cache.

snapshotArnsToRestoreOptional
string[]

The ARN of the snapshot from which to restore data into the new cache.

snapshotRetentionLimitOptional
number

The current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS and Serverless Memcached only.

subnetIdsOptional
string | ISubnetRef[]

If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.

tagsOptional
CfnTag[]

A list of tags to be added to this resource.

userGroupIdOptional
string | IUserGroupRef

The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter