origin_access_control_configs

Creates, updates, deletes, gets or lists an origin_access_control_configs resource.

Overview

Name	origin_access_control_configs
Type	Resource
Id	aws.cloudfront.origin_access_control_configs

Fields

The following fields are returned by SELECT queries:

get_origin_access_control_config

Name	Datatype	Description
description	string	A description of the origin access control.
name	string	A name to identify the origin access control. You can specify up to 64 characters.
origin_access_control_origin_type	string	The type of origin that this origin access control is for.
signing_behavior	string	Specifies which requests CloudFront signs (adds authentication information to). Specify always for the most common use case. For more information, see origin access control advanced settings in the Amazon CloudFront Developer Guide. This field can have one of the following values: always – CloudFront signs all origin requests, overwriting the Authorization header from the viewer request if one exists. never – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control. no-override – If the viewer request doesn't contain the Authorization header, then CloudFront signs the origin request. If the viewer request contains the Authorization header, then CloudFront doesn't sign the origin request and instead passes along the Authorization header from the viewer request. WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.
signing_protocol	string	The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is sigv4.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_origin_access_control_config	select	id, region		Gets a CloudFront origin access control 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 unique identifier of the origin access control.
region	string	AWS region (default: us-east-1)

SELECT examples

get_origin_access_control_config

Gets a CloudFront origin access control configuration.

SELECT
description,
name,
origin_access_control_origin_type,
signing_behavior,
signing_protocol
FROM aws.cloudfront.origin_access_control_configs
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;