CreateServerlessCache
Creates a serverless cache.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Engine
-
The name of the cache engine to be used for creating the serverless cache.
Type: String
Required: Yes
- ServerlessCacheName
-
User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.
Type: String
Required: Yes
- CacheUsageLimits
-
Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.
Type: CacheUsageLimits object
Required: No
- DailySnapshotTime
-
The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Redis only.
Type: String
Required: No
- Description
-
User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.
Type: String
Required: No
- KmsKeyId
-
ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
Type: String
Required: No
- MajorEngineVersion
-
The version of the cache engine that will be used to create the serverless cache.
Type: String
Required: No
- SecurityGroupIds.SecurityGroupId.N
-
A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
Type: Array of strings
Required: No
- SnapshotArnsToRestore.SnapshotArn.N
-
The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
Type: Array of strings
Required: No
- SnapshotRetentionLimit
-
The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
Type: Integer
Required: No
- SubnetIds.SubnetId.N
-
A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
Type: Array of strings
Required: No
- Tags.Tag.N
-
The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.
Type: Array of Tag objects
Required: No
- UserGroupId
-
The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
Type: String
Required: No
Response Elements
The following element is returned by the service.
- ServerlessCache
-
The response for the attempt to create the serverless cache.
Type: ServerlessCache object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidCredentials
-
You must enter valid credentials.
HTTP Status Code: 408
- 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
- InvalidUserGroupState
-
The user group is not in an active state.
HTTP Status Code: 400
- ServerlessCacheAlreadyExistsFault
-
A serverless cache with this name already exists.
HTTP Status Code: 400
- ServerlessCacheNotFoundFault
-
The serverless cache was not found or does not exist.
HTTP Status Code: 404
- ServerlessCacheQuotaForCustomerExceededFault
-
The number of serverless caches exceeds the customer quota.
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
- UserGroupNotFound
-
The user group was not found or does not exist
HTTP Status Code: 404
Examples
CreateServerlessCache (Redis)
This example illustrates one usage of CreateServerlessCache.
Sample Request
{
"input": {
"ServerlessCacheName": "my-serverless-cache",
"Description": "A serverless cache.",
"Engine": "redis",
"MajorEngineVersion": "7",
"SubnetIds": [
"subnet-xxx8c982",
"subnet-xxx382f3",
"subnet-xxxb3e7c0"
],
"CacheUsageLimits": {
"DataStorage" : {
"Maximum" : 10,
"Unit" : "GB"
},
"ECPUPerSecond" : {
"Maximum" : 50000
}
},
"SecurityGroupIds": [
"sg-xxx0c9af"
],
"SnapshotRetentionLimit": 10,
"DailySnapshotTime": "09:00"
},
"output": {
"ServerlessCache": {
"ServerlessCacheName": "my-serverless-cache",
"Description": "A serverless cache.",
"Status": "creating",
"Engine": "redis",
"MajorEngineVersion": "7",
"FullEngineVersion": "7.0",
"SubnetIds": [
"subnet-xxx8c982",
"subnet-xxx382f3",
"subnet-xxxb3e7c0"
],
"CacheUsageLimits": {
"DataStorage" : {
"Maximum" : 10,
"Unit" : "GB"
},
"ECPUPerSecond" : {
"Maximum" : 50000
}
},
"SecurityGroupIds": [
"sg-xxx0c9af"
],
"ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscache:my-serverless-cache",
"SnapshotRetentionLimit": 10,
"DailySnapshotTime": "09:00"
}
}
}CreateServerlessCache (Memcached)
This example illustrates one usage of CreateServerlessCache.
Sample Request
{
"input": {
"ServerlessCacheName": "my-serverless-cache",
"Description": "A serverless cache.",
"Engine": "memcached",
"MajorEngineVersion": "1.6",
"SubnetIds": [
"subnet-xxx8c982",
"subnet-xxx382f3",
"subnet-xxxb3e7c0"
],
"CacheUsageLimits": {
"DataStorage" : {
"Maximum" : 10,
"Unit" : "GB"
},
"ECPUPerSecond" : {
"Maximum" : 50000
}
},
"SecurityGroupIds": [
"sg-xxx0c9af"
]
},
"output": {
"ServerlessCache": {
"ServerlessCacheName": "my-serverless-cache",
"Description": "A serverless cache.",
"Status": "creating",
"Engine": "memcached",
"MajorEngineVersion": "1.6",
"FullEngineVersion": "1.6.21",
"SubnetIds": [
"subnet-xxx8c982",
"subnet-xxx382f3",
"subnet-xxxb3e7c0"
],
"CacheUsageLimits": {
"DataStorage" : {
"Maximum" : 10,
"Unit" : "GB"
},
"ECPUPerSecond" : {
"Maximum" : 50000
}
},
"SecurityGroupIds": [
"sg-xxx0c9af"
],
"ARN": "arn:aws:elasticache:us-east-1:222222222222:serverlesscache:my-serverless-cache",
}
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
