field_level_encryption_profiles

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

Overview

Name	field_level_encryption_profiles
Type	Resource
Id	aws.cloudfront.field_level_encryption_profiles

Fields

The following fields are returned by SELECT queries:

get_field_level_encryption_profile

Name	Datatype	Description
field_level_encryption_profile_config	string	A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.
id	string	The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.
last_modified_time	string	The last time the field-level encryption profile was updated.

list_field_level_encryption_profiles

Name	Datatype	Description
items	string	The field-level encryption profile items.
max_items	integer	The maximum number of field-level encryption profiles 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 profiles where you left off.
quantity	integer	The number of field-level encryption profiles.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_field_level_encryption_profile	select	id, region		Get the field-level encryption profile information.
list_field_level_encryption_profiles	select	region	Marker, MaxItems	Request a list of field-level encryption profiles that have been created in CloudFront for this account.
create_field_level_encryption_profile	insert	region, FieldLevelEncryptionProfileConfig		Create a field-level encryption profile.
update_field_level_encryption_profile	update	id, region, FieldLevelEncryptionProfileConfig	If-Match	Update a field-level encryption profile.
delete_field_level_encryption_profile	delete	id, region	If-Match	Remove a field-level encryption profile.

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	Request the ID of the profile 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 profile to delete. For example: E2QWRUHAPOMQZL.
Marker	string	Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles 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 profile on that page).
MaxItems	string	The maximum number of field-level encryption profiles you want in the response body.

SELECT examples

get_field_level_encryption_profile

Get the field-level encryption profile information.

SELECT
field_level_encryption_profile_config,
id,
last_modified_time
FROM aws.cloudfront.field_level_encryption_profiles
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_field_level_encryption_profiles

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

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

INSERT examples

create_field_level_encryption_profile

Create a field-level encryption profile.

INSERT INTO aws.cloudfront.field_level_encryption_profiles (
FieldLevelEncryptionProfileConfig,
region
)
SELECT 
'{{ FieldLevelEncryptionProfileConfig }}' /* required */,
'{{ region }}'
RETURNING
field_level_encryption_profile_config,
id,
last_modified_time
;

Manifest

# Description fields are for documentation purposes
- name: field_level_encryption_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the field_level_encryption_profiles resource.
  - name: FieldLevelEncryptionProfileConfig
    description: |
      A complex data type of profiles for the field-level encryption.
    value:
      Name: "{{ Name }}"
      CallerReference: "{{ CallerReference }}"
      Comment: "{{ Comment }}"
      EncryptionEntities:
        Quantity: {{ Quantity }}
        Items:
          - PublicKeyId: "{{ PublicKeyId }}"
            ProviderId: "{{ ProviderId }}"
            FieldPatterns:
              Quantity: {{ Quantity }}
              Items:
                - "{{ Items }}"

UPDATE examples

update_field_level_encryption_profile

Update a field-level encryption profile.

UPDATE aws.cloudfront.field_level_encryption_profiles
SET 
FieldLevelEncryptionProfileConfig = '{{ FieldLevelEncryptionProfileConfig }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND FieldLevelEncryptionProfileConfig = '{{ FieldLevelEncryptionProfileConfig }}' --required
AND `If-Match` = '{{ If-Match}}'
RETURNING
field_level_encryption_profile_config,
id,
last_modified_time;

DELETE examples

delete_field_level_encryption_profile

Remove a field-level encryption profile.

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