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	awscc.cloudfront.key_value_stores

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the key value store.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	key_value_stores	INSERT	Name, region
delete_resource	key_value_stores	DELETE	Identifier, region
update_resource	key_value_stores	UPDATE	Identifier, PatchDocument, region
list_resources	key_value_stores_list_only	SELECT	region
get_resource	key_value_stores	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual key_value_store.

SELECT
  region,
  arn,
  id,
  status,
  name,
  comment,
  import_source
FROM awscc.cloudfront.key_value_stores
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all key_value_stores in a region.

SELECT
  region,
  name
FROM awscc.cloudfront.key_value_stores_list_only
WHERE
  region = 'us-east-1';

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 awscc.cloudfront.key_value_stores (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudfront.key_value_stores (
  Name,
  Comment,
  ImportSource,
  region
)
SELECT
  '{{ name }}',
  '{{ comment }}',
  '{{ import_source }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: import_source
      value:
        source_type: '{{ source_type }}'
        source_arn: '{{ source_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cloudfront.key_value_stores
SET PatchDocument = string('{{ {
    "Comment": comment,
    "ImportSource": import_source
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cloudfront.key_value_stores
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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