CreateOriginAccessControl
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.
Request Syntax
POST /2020-05-31/origin-access-control HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<OriginAccessControlConfig xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
<Description>string
</Description>
<Name>string
</Name>
<OriginAccessControlOriginType>string
</OriginAccessControlOriginType>
<SigningBehavior>string
</SigningBehavior>
<SigningProtocol>string
</SigningProtocol>
</OriginAccessControlConfig>
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in XML format.
- OriginAccessControlConfig
-
Root level tag for the OriginAccessControlConfig parameters.
Required: Yes
- Description
-
A description of the origin access control.
Type: String
Required: No
- Name
-
A name to identify the origin access control. You can specify up to 64 characters.
Type: String
Required: Yes
- OriginAccessControlOriginType
-
The type of origin that this origin access control is for.
Type: String
Valid Values:
s3 | mediastore | mediapackagev2 | lambda
Required: Yes
- 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.
Type: String
Valid Values:
never | always | no-override
Required: Yes
-
- SigningProtocol
-
The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is
sigv4
.Type: String
Valid Values:
sigv4
Required: Yes
Response Syntax
HTTP/1.1 201
<?xml version="1.0" encoding="UTF-8"?>
<OriginAccessControl>
<Id>string</Id>
<OriginAccessControlConfig>
<Description>string</Description>
<Name>string</Name>
<OriginAccessControlOriginType>string</OriginAccessControlOriginType>
<SigningBehavior>string</SigningBehavior>
<SigningProtocol>string</SigningProtocol>
</OriginAccessControlConfig>
</OriginAccessControl>
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in XML format by the service.
- OriginAccessControl
-
Root level tag for the OriginAccessControl parameters.
Required: Yes
- Id
-
The unique identifier of the origin access control.
Type: String
- OriginAccessControlConfig
-
The origin access control.
Type: OriginAccessControlConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArgument
-
An argument is invalid.
HTTP Status Code: 400
- OriginAccessControlAlreadyExists
-
An origin access control with the specified parameters already exists.
HTTP Status Code: 409
- TooManyOriginAccessControls
-
The number of origin access controls in your Amazon Web Services account exceeds the maximum allowed.
For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: