serverless_caches

Creates, updates, deletes or gets a serverless_cach resource or lists serverless_caches in a region

Overview

Name	serverless_caches
Type	Resource
Description	The AWS::ElastiCache::ServerlessCache resource creates an Amazon ElastiCache Serverless Cache.
Id	aws.elasticache.serverless_caches

Fields

Name	Datatype	Description
serverless_cache_name	string	The name of the Serverless Cache. This value must be unique.
description	string	The description of the Serverless Cache.
engine	string	The engine name of the Serverless Cache.
major_engine_version	string	The major engine version of the Serverless Cache.
full_engine_version	string	The full engine version of the Serverless Cache.
cache_usage_limits	object	The cache capacity limit of the Serverless Cache.
kms_key_id	string	The ID of the KMS key used to encrypt the cluster.
security_group_ids	array	One or more Amazon VPC security groups associated with this Serverless Cache.
snapshot_arns_to_restore	array	The ARN's of snapshot to restore Serverless Cache.
tags	array	An array of key-value pairs to apply to this Serverless Cache.
user_group_id	string	The ID of the user group.
subnet_ids	array	The subnet id's of the Serverless Cache.
snapshot_retention_limit	integer	The snapshot retention limit of the Serverless Cache.
daily_snapshot_time	string	The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache.
create_time	string	The creation time of the Serverless Cache.
status	string	The status of the Serverless Cache.
endpoint	object	The address and the port.
reader_endpoint	object	The address and the port.
arn	string	The ARN of the Serverless Cache.
final_snapshot_name	string	The final snapshot name which is taken before Serverless Cache is deleted.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ServerlessCacheName, Engine, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all serverless_caches in a region.

SELECT
region,
serverless_cache_name,
description,
engine,
major_engine_version,
full_engine_version,
cache_usage_limits,
kms_key_id,
security_group_ids,
snapshot_arns_to_restore,
tags,
user_group_id,
subnet_ids,
snapshot_retention_limit,
daily_snapshot_time,
create_time,
status,
endpoint,
reader_endpoint,
arn,
final_snapshot_name
FROM aws.elasticache.serverless_caches
WHERE region = 'us-east-1';

Gets all properties from an individual serverless_cach.

SELECT
region,
serverless_cache_name,
description,
engine,
major_engine_version,
full_engine_version,
cache_usage_limits,
kms_key_id,
security_group_ids,
snapshot_arns_to_restore,
tags,
user_group_id,
subnet_ids,
snapshot_retention_limit,
daily_snapshot_time,
create_time,
status,
endpoint,
reader_endpoint,
arn,
final_snapshot_name
FROM aws.elasticache.serverless_caches
WHERE region = 'us-east-1' AND data__Identifier = '<ServerlessCacheName>';

INSERT example

Use the following StackQL query and manifest file to create a new serverless_cach resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.elasticache.serverless_caches (
 ServerlessCacheName,
 Engine,
 region
)
SELECT 
'{{ ServerlessCacheName }}',
 '{{ Engine }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.elasticache.serverless_caches (
 ServerlessCacheName,
 Description,
 Engine,
 MajorEngineVersion,
 CacheUsageLimits,
 KmsKeyId,
 SecurityGroupIds,
 SnapshotArnsToRestore,
 Tags,
 UserGroupId,
 SubnetIds,
 SnapshotRetentionLimit,
 DailySnapshotTime,
 Endpoint,
 ReaderEndpoint,
 FinalSnapshotName,
 region
)
SELECT 
 '{{ ServerlessCacheName }}',
 '{{ Description }}',
 '{{ Engine }}',
 '{{ MajorEngineVersion }}',
 '{{ CacheUsageLimits }}',
 '{{ KmsKeyId }}',
 '{{ SecurityGroupIds }}',
 '{{ SnapshotArnsToRestore }}',
 '{{ Tags }}',
 '{{ UserGroupId }}',
 '{{ SubnetIds }}',
 '{{ SnapshotRetentionLimit }}',
 '{{ DailySnapshotTime }}',
 '{{ Endpoint }}',
 '{{ ReaderEndpoint }}',
 '{{ FinalSnapshotName }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: serverless_cach
    props:
      - name: ServerlessCacheName
        value: '{{ ServerlessCacheName }}'
      - name: Description
        value: '{{ Description }}'
      - name: Engine
        value: '{{ Engine }}'
      - name: MajorEngineVersion
        value: '{{ MajorEngineVersion }}'
      - name: CacheUsageLimits
        value:
          DataStorage:
            Minimum: '{{ Minimum }}'
            Maximum: '{{ Maximum }}'
            Unit: '{{ Unit }}'
          ECPUPerSecond:
            Minimum: '{{ Minimum }}'
            Maximum: '{{ Maximum }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: SecurityGroupIds
        value:
          - '{{ SecurityGroupIds[0] }}'
      - name: SnapshotArnsToRestore
        value:
          - '{{ SnapshotArnsToRestore[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: UserGroupId
        value: '{{ UserGroupId }}'
      - name: SubnetIds
        value:
          - '{{ SubnetIds[0] }}'
      - name: SnapshotRetentionLimit
        value: '{{ SnapshotRetentionLimit }}'
      - name: DailySnapshotTime
        value: '{{ DailySnapshotTime }}'
      - name: Endpoint
        value:
          Address: '{{ Address }}'
          Port: '{{ Port }}'
      - name: ReaderEndpoint
        value: null
      - name: FinalSnapshotName
        value: '{{ FinalSnapshotName }}'

DELETE example

/*+ delete */
DELETE FROM aws.elasticache.serverless_caches
WHERE data__Identifier = '<ServerlessCacheName>'
AND region = 'us-east-1';

Permissions

To operate on the serverless_caches resource, the following permissions are required:

Create

elasticache:CreateServerlessCache,
elasticache:DescribeServerlessCaches,
elasticache:AddTagsToResource,
elasticache:ListTagsForResource,
ec2:CreateTags,
ec2:CreateVpcEndpoint,
kms:CreateGrant,
kms:DescribeKey

Read

elasticache:DescribeServerlessCaches,
elasticache:ListTagsForResource

Update

elasticache:ModifyServerlessCache,
elasticache:DescribeServerlessCaches,
elasticache:AddTagsToResource,
elasticache:ListTagsForResource,
elasticache:RemoveTagsFromResource

Delete

elasticache:DeleteServerlessCache,
elasticache:DescribeServerlessCaches,
elasticache:ListTagsForResource

List

elasticache:DescribeServerlessCaches,
elasticache:ListTagsForResource