connection_functions

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

Overview

Name	connection_functions
Type	Resource
Id	aws.cloudfront.connection_functions

Fields

The following fields are returned by SELECT queries:

describe_connection_function

Name	Datatype	Description
connection_function_summary	string	The connection function's summary.
e_tag	string	The version identifier for the current version of the connection function.

list_connection_functions

Name	Datatype	Description
connection_function_arn	string	The connection function Amazon Resource Name (ARN).
connection_function_config	string	Contains configuration information about a CloudFront function.
created_time	string	The connection function created time.
id	string	The connection function ID.
last_modified_time	string	The connection function last modified time.
name	string	The connection function name.
stage	string	The connection function stage.
status	string	The connection function status.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_connection_function	select	identifier, region	Stage	Describes a connection function.
list_connection_functions	select	region		Lists connection functions.
create_connection_function	insert	region, ConnectionFunctionConfig, ConnectionFunctionCode		Creates a connection function.
update_connection_function	update	id, If-Match, region, ConnectionFunctionConfig, ConnectionFunctionCode		Updates a connection function.
delete_connection_function	delete	id, If-Match, region		Deletes a connection function.
get_connection_function	exec	identifier, region	Stage	Gets a connection function.

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 current version (ETag value) of the connection function you are deleting.
id	string	The connection function's ID.
identifier	string	The connection function's identifier.
region	string	AWS region (default: us-east-1)
Stage	string	The connection function's stage.

SELECT examples

describe_connection_function

Describes a connection function.

SELECT
connection_function_summary,
e_tag
FROM aws.cloudfront.connection_functions
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
AND Stage = '{{ Stage }}'
;

list_connection_functions

Lists connection functions.

SELECT
connection_function_arn,
connection_function_config,
created_time,
id,
last_modified_time,
name,
stage,
status
FROM aws.cloudfront.connection_functions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connection_function

Creates a connection function.

INSERT INTO aws.cloudfront.connection_functions (
Name,
ConnectionFunctionConfig,
ConnectionFunctionCode,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ ConnectionFunctionConfig }}' /* required */,
'{{ ConnectionFunctionCode }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
connection_function_summary,
e_tag,
location
;

Manifest

# Description fields are for documentation purposes
- name: connection_functions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connection_functions resource.
  - name: Name
    value: "{{ Name }}"
  - name: ConnectionFunctionConfig
    description: |
      Contains configuration information about a CloudFront function.
    value:
      Comment: "{{ Comment }}"
      Runtime: "{{ Runtime }}"
      KeyValueStoreAssociations:
        Quantity: {{ Quantity }}
        Items:
          - KeyValueStoreARN: "{{ KeyValueStoreARN }}"
  - name: ConnectionFunctionCode
    value: "{{ ConnectionFunctionCode }}"
  - name: Tags
    description: |
      A complex type that contains zero or more Tag elements.
    value:
      Items:
        - Key: "{{ Key }}"
          Value: "{{ Value }}"

UPDATE examples

update_connection_function

Updates a connection function.

UPDATE aws.cloudfront.connection_functions
SET 
ConnectionFunctionConfig = '{{ ConnectionFunctionConfig }}',
ConnectionFunctionCode = '{{ ConnectionFunctionCode }}'
WHERE 
id = '{{ id }}' --required
AND `If-Match` = '{{ If-Match }}' --required
AND region = '{{ region }}' --required
AND ConnectionFunctionConfig = '{{ ConnectionFunctionConfig }}' --required
AND ConnectionFunctionCode = '{{ ConnectionFunctionCode }}' --required
RETURNING
connection_function_summary,
e_tag;

DELETE examples

delete_connection_function

Deletes a connection function.

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

Lifecycle Methods

get_connection_function

Gets a connection function.

EXEC aws.cloudfront.connection_functions.get_connection_function 
@identifier='{{ identifier }}' --required, 
@region='{{ region }}' --required, 
@Stage='{{ Stage }}'
;