key_value_stores

Creates, updates, deletes or gets a key_value_store resource or lists key_value_stores in a region

Overview

Name	key_value_stores
Type	Resource
Description	The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.
Id	aws.cloudfront.key_value_stores

Fields

Name	Datatype	Description
arn	string
id	string
status	string
name	string	The name of the key value store.
comment	string	A comment for the key value store.
import_source	object	The import source for the key value store.
region	string	AWS region.

For more information, see AWS::CloudFront::KeyValueStore.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, 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 key_value_stores in a region.

SELECT
region,
arn,
id,
status,
name,
comment,
import_source
FROM aws.cloudfront.key_value_stores
;

Gets all properties from an individual key_value_store.

SELECT
region,
arn,
id,
status,
name,
comment,
import_source
FROM aws.cloudfront.key_value_stores
WHERE data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cloudfront.key_value_stores (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cloudfront.key_value_stores (
 Name,
 Comment,
 ImportSource,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Comment }}',
 '{{ ImportSource }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: key_value_store
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Comment
        value: '{{ Comment }}'
      - name: ImportSource
        value:
          SourceType: '{{ SourceType }}'
          SourceArn: '{{ SourceArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.cloudfront.key_value_stores
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

cloudfront:CreateKeyValueStore,
cloudfront:DescribeKeyValueStore,
s3:GetObject,
s3:HeadObject,
s3:GetBucketLocation

Delete

cloudfront:DeleteKeyValueStore,
cloudfront:DescribeKeyValueStore

List

cloudfront:ListKeyValueStores

Read

cloudfront:DescribeKeyValueStore

Update

cloudfront:UpdateKeyValueStore,
cloudfront:DescribeKeyValueStore