key_value_stores

Creates, updates, deletes, gets or lists a key_value_stores resource.

Overview

Name	key_value_stores
Type	Resource
Id	aws.cloudfront.key_value_stores

Fields

The following fields are returned by SELECT queries:

describe_key_value_store

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the key value store.
comment	string	A comment for the key value store.
id	string	The unique Id for the key value store.
last_modified_time	string	The last-modified time of the key value store.
name	string	The name of the key value store.
status	string	The status of the key value store.

list_key_value_stores

Name	Datatype	Description
items	string	The items of the key value store list.
max_items	integer	The maximum number of items in the key value store list.
next_marker	string	The next marker associated with the key value store list.
quantity	integer	The quantity of the key value store list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_key_value_store	select	name, region		Specifies the key value store and its configuration.
list_key_value_stores	select	region	Marker, MaxItems, Status	Specifies the key value stores to list.
create_key_value_store	insert	region		Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.
update_key_value_store	update	name, If-Match, region		Specifies the key value store to update.
delete_key_value_store	delete	name, If-Match, region		Specifies the key value store to delete.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
If-Match	string	The key value store to delete, if a match occurs.
name	string	The name of the key value store.
region	string	AWS region (default: us-east-1)
Marker	string	The marker associated with the key value stores list.
MaxItems	string	The maximum number of items in the key value stores list.
Status	string	The status of the request for the key value stores list.

SELECT examples

describe_key_value_store

Specifies the key value store and its configuration.

SELECT
arn,
comment,
id,
last_modified_time,
name,
status
FROM aws.cloudfront.key_value_stores
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_key_value_stores

Specifies the key value stores to list.

SELECT
items,
max_items,
next_marker,
quantity
FROM aws.cloudfront.key_value_stores
WHERE region = '{{ region }}' -- required
AND Marker = '{{ Marker }}'
AND MaxItems = '{{ MaxItems }}'
AND Status = '{{ Status }}'
;

INSERT examples

create_key_value_store

Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.

INSERT INTO aws.cloudfront.key_value_stores (
Name,
Comment,
ImportSource,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ Comment }}',
'{{ ImportSource }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
comment,
id,
last_modified_time,
name,
status
;

Manifest

# Description fields are for documentation purposes
- name: key_value_stores
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the key_value_stores resource.
  - name: Name
    value: "{{ Name }}"
  - name: Comment
    value: "{{ Comment }}"
  - name: ImportSource
    description: |
      The import source for the key value store.
    value:
      SourceType: "{{ SourceType }}"
      SourceARN: "{{ SourceARN }}"
  - name: Tags
    description: |
      A complex type that contains zero or more Tag elements.
    value:
      Items:
        - Key: "{{ Key }}"
          Value: "{{ Value }}"

UPDATE examples

update_key_value_store

Specifies the key value store to update.

UPDATE aws.cloudfront.key_value_stores
SET 
Comment = '{{ Comment }}'
WHERE 
name = '{{ name }}' --required
AND `If-Match` = '{{ If-Match }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
comment,
id,
last_modified_time,
name,
status;

DELETE examples

delete_key_value_store

Specifies the key value store to delete.

DELETE FROM aws.cloudfront.key_value_stores
WHERE name = '{{ name }}' --required
AND `If-Match` = '{{ If-Match }}' --required
AND region = '{{ region }}' --required
;