AWS::ElastiCache::ServerlessCache - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ElastiCache::ServerlessCache

The resource representing a serverless cache.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ElastiCache::ServerlessCache",
  "Properties" : {
      "CacheUsageLimits" : CacheUsageLimits,
      "DailySnapshotTime" : String,
      "Description" : String,
      "Endpoint" : Endpoint,
      "Engine" : String,
      "FinalSnapshotName" : String,
      "KmsKeyId" : String,
      "MajorEngineVersion" : String,
      "ReaderEndpoint" : Endpoint,
      "SecurityGroupIds" : [ String, ... ],
      "ServerlessCacheName" : String,
      "SnapshotArnsToRestore" : [ String, ... ],
      "SnapshotRetentionLimit" : Integer,
      "SubnetIds" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "UserGroupId" : String
    }
}

YAML

Type: AWS::ElastiCache::ServerlessCache
Properties:
  CacheUsageLimits: 
    CacheUsageLimits
  DailySnapshotTime: String
  Description: String
  Endpoint: 
    Endpoint
  Engine: String
  FinalSnapshotName: String
  KmsKeyId: String
  MajorEngineVersion: String
  ReaderEndpoint: 
    Endpoint
  SecurityGroupIds: 
    - String
  ServerlessCacheName: String
  SnapshotArnsToRestore: 
    - String
  SnapshotRetentionLimit: Integer
  SubnetIds: 
    - String
  Tags: 
    - Tag
  UserGroupId: String

Properties

CacheUsageLimits

The cache usage limit for the serverless cache.

Required: No

Type: CacheUsageLimits

Update requires: No interruption

DailySnapshotTime

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.

Required: No

Type: String

Update requires: No interruption

Description

A description of the serverless cache.

Required: No

Type: String

Update requires: No interruption

Endpoint

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

Required: No

Type: Endpoint

Update requires: No interruption

Engine

The engine the serverless cache is compatible with.

Required: Yes

Type: String

Update requires: No interruption

FinalSnapshotName

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

Required: No

Type: String

Update requires: No interruption

KmsKeyId

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

Required: No

Type: String

Update requires: Replacement

MajorEngineVersion

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

Required: No

Type: String

Update requires: No interruption

ReaderEndpoint

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

Required: No

Type: Endpoint

Update requires: No interruption

SecurityGroupIds

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

Required: No

Type: Array of String

Update requires: No interruption

ServerlessCacheName

The unique identifier of the serverless cache.

Required: Yes

Type: String

Update requires: Replacement

SnapshotArnsToRestore

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

Required: No

Type: Array of String

Update requires: Replacement

SnapshotRetentionLimit

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

Required: No

Type: Integer

Update requires: No interruption

SubnetIds

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.

Required: No

Type: Array of String

Update requires: Replacement

Tags

A list of tags to be added to this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

UserGroupId

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

Required: No

Type: String

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ARN

The Amazon Resource Name (ARN) of the serverless cache.

CreateTime

When the serverless cache was created.

Endpoint.Address

The DNS hostname of the cache node.

Endpoint.Port

The port number that the cache engine is listening on.

FullEngineVersion

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

ReaderEndpoint.Address

The port used by the reader endpoint.

ReaderEndpoint.Port

The port used by the endpoint.

Status

The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.