Request Parameters Response Elements Errors Examples See Also

CreateServerlessCacheSnapshot

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ServerlessCacheName

The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.

Type: String

Required: Yes

ServerlessCacheSnapshotName

The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only. Must be between 1 and 255 characters.

Type: String

Required: Yes

KmsKeyId

The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

Type: String

Required: No

Tags.Tag.N

A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

ServerlessCacheSnapshot

The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.

Type: ServerlessCacheSnapshot object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

InvalidServerlessCacheStateFault

The account for these credentials is not currently active.

HTTP Status Code: 400

ServerlessCacheNotFoundFault

The serverless cache was not found or does not exist.

HTTP Status Code: 404

ServerlessCacheSnapshotAlreadyExistsFault

A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.

HTTP Status Code: 400

ServerlessCacheSnapshotQuotaExceededFault

The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.

HTTP Status Code: 400

ServiceLinkedRoleNotFoundFault

The specified service linked role (SLR) was not found.

HTTP Status Code: 400

TagQuotaPerResourceExceeded

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

HTTP Status Code: 400

Examples

CreateServerlessCacheSnapshot

This example illustrates one usage of CreateServerlessCacheSnapshot.

Sample Request


{
    "input": {
        "ServerlessCacheSnapshotName": "my-serverless-cache-snapshot",
        "ServerlessCacheName": "my-serverless-cache"
    },
    "output": {
        "ServerlessCacheSnapshot": {
            "ServerlessCacheSnapshotName": "my-serverless-cache-snapshot",
            "ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscachesnapshot:my-serverless-cache-snapshot",
            "SnapshotType": "manual",
            "Status": "creating",
            "ServerlessCacheConfiguration": {
                "ServerlessCacheName": "my-serverless-cache",
                "Engine": "redis",
                "MajorEngineVersion": "7"
            }
        }    
    }
}