field_level_encryption_configs

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

Overview

Name	field_level_encryption_configs
Type	Resource
Id	aws.cloudfront.field_level_encryption_configs

Fields

The following fields are returned by SELECT queries:

get_field_level_encryption_config

Name	Datatype	Description
caller_reference	string	A unique number that ensures the request can't be replayed.
comment	string	An optional comment about the configuration. The comment cannot be longer than 128 characters.
content_type_profile_config	string	A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
query_arg_profile_config	string	A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.

list_field_level_encryption_configs

Name	Datatype	Description
items	string	An array of field-level encryption items.
max_items	integer	The maximum number of elements you want in the response body.
next_marker	string	If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.
quantity	integer	The number of field-level encryption items.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_field_level_encryption_config	select	id, region		Get the field-level encryption configuration information.
list_field_level_encryption_configs	select	region	Marker, MaxItems	List all field-level encryption configurations that have been created in CloudFront for this account.
create_field_level_encryption_config	insert	region, FieldLevelEncryptionConfig		Create a new field-level encryption configuration.
update_field_level_encryption_config	update	id, region, FieldLevelEncryptionConfig	If-Match	Update a field-level encryption configuration.
delete_field_level_encryption_config	delete	id, region	If-Match	Remove a field-level encryption configuration.

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
id	string	The ID of the configuration you want to delete from CloudFront.
region	string	AWS region (default: us-east-1)
If-Match	string	The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.
Marker	string	Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).
MaxItems	string	The maximum number of field-level encryption configurations you want in the response body.

SELECT examples

get_field_level_encryption_config

Get the field-level encryption configuration information.

SELECT
caller_reference,
comment,
content_type_profile_config,
query_arg_profile_config
FROM aws.cloudfront.field_level_encryption_configs
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_field_level_encryption_configs

List all field-level encryption configurations that have been created in CloudFront for this account.

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

INSERT examples

create_field_level_encryption_config

Create a new field-level encryption configuration.

INSERT INTO aws.cloudfront.field_level_encryption_configs (
FieldLevelEncryptionConfig,
region
)
SELECT 
'{{ FieldLevelEncryptionConfig }}' /* required */,
'{{ region }}'
RETURNING
e_tag,
field_level_encryption,
location
;

Manifest

# Description fields are for documentation purposes
- name: field_level_encryption_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the field_level_encryption_configs resource.
  - name: FieldLevelEncryptionConfig
    description: |
      A complex data type that includes the profile configurations specified for field-level encryption.
    value:
      CallerReference: "{{ CallerReference }}"
      Comment: "{{ Comment }}"
      QueryArgProfileConfig:
        ForwardWhenQueryArgProfileIsUnknown: {{ ForwardWhenQueryArgProfileIsUnknown }}
        QueryArgProfiles:
          Quantity: {{ Quantity }}
          Items:
            - QueryArg: "{{ QueryArg }}"
              ProfileId: "{{ ProfileId }}"
      ContentTypeProfileConfig:
        ForwardWhenContentTypeIsUnknown: {{ ForwardWhenContentTypeIsUnknown }}
        ContentTypeProfiles:
          Quantity: {{ Quantity }}
          Items:
            - Format: "{{ Format }}"
              ProfileId: "{{ ProfileId }}"
              ContentType: "{{ ContentType }}"

UPDATE examples

update_field_level_encryption_config

Update a field-level encryption configuration.

UPDATE aws.cloudfront.field_level_encryption_configs
SET 
FieldLevelEncryptionConfig = '{{ FieldLevelEncryptionConfig }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND FieldLevelEncryptionConfig = '{{ FieldLevelEncryptionConfig }}' --required
AND `If-Match` = '{{ If-Match}}'
RETURNING
e_tag,
field_level_encryption;

DELETE examples

delete_field_level_encryption_config

Remove a field-level encryption configuration.

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