AWS::CloudFront::OriginAccessControl OriginAccessControlConfig
Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon origin in the Amazon CloudFront Developer Guide.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Description" :
String
, "Name" :String
, "OriginAccessControlOriginType" :String
, "SigningBehavior" :String
, "SigningProtocol" :String
}
YAML
Description:
String
Name:String
OriginAccessControlOriginType:String
SigningBehavior:String
SigningProtocol:String
Properties
Description
-
A description of the origin access control.
Required: No
Type: String
Update requires: No interruption
Name
-
A name to identify the origin access control. You can specify up to 64 characters.
Required: Yes
Type: String
Update requires: No interruption
OriginAccessControlOriginType
-
The type of origin that this origin access control is for.
Required: Yes
Type: String
Pattern:
^(s3|mediastore|lambda|mediapackagev2)$
Update requires: No interruption
SigningBehavior
-
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 theAuthorization
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 theAuthorization
header, then CloudFront signs the origin request. If the viewer request contains theAuthorization
header, then CloudFront doesn't sign the origin request and instead passes along theAuthorization
header from the viewer request. WARNING: To pass along theAuthorization
header from the viewer request, you must add theAuthorization
header to a cache policy for all cache behaviors that use origins associated with this origin access control.
Required: Yes
Type: String
Pattern:
^(never|no-override|always)$
Update requires: No interruption
-
SigningProtocol
-
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is
sigv4
.Required: Yes
Type: String
Pattern:
^(sigv4)$
Update requires: No interruption