CloudFront / Client / create_origin_request_policy

create_origin_request_policy#

CloudFront.Client.create_origin_request_policy(**kwargs)#

Creates an origin request policy.

After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:

  • The request body and the URL path (without the domain name) from the viewer request.

  • The headers that CloudFront automatically includes in every origin request, including Host , User-Agent , and X-Amz-Cf-Id .

  • All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy .

For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_origin_request_policy(
    OriginRequestPolicyConfig={
        'Comment': 'string',
        'Name': 'string',
        'HeadersConfig': {
            'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront'|'allExcept',
            'Headers': {
                'Quantity': 123,
                'Items': [
                    'string',
                ]
            }
        },
        'CookiesConfig': {
            'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept',
            'Cookies': {
                'Quantity': 123,
                'Items': [
                    'string',
                ]
            }
        },
        'QueryStringsConfig': {
            'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept',
            'QueryStrings': {
                'Quantity': 123,
                'Items': [
                    'string',
                ]
            }
        }
    }
)
Parameters:

OriginRequestPolicyConfig (dict) –

[REQUIRED]

An origin request policy configuration.

  • Comment (string) –

    A comment to describe the origin request policy. The comment cannot be longer than 128 characters.

  • Name (string) – [REQUIRED]

    A unique name to identify the origin request policy.

  • HeadersConfig (dict) – [REQUIRED]

    The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

    • HeaderBehavior (string) – [REQUIRED]

      Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:

      • none – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.

      • whitelist – Only the HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.

      • allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.

      • allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.

      • allExcept – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the Headers type, which are not included.

    • Headers (dict) –

      Contains a list of HTTP header names.

      • Quantity (integer) – [REQUIRED]

        The number of header names in the Items list.

      • Items (list) –

        A list of HTTP header names.

        • (string) –

  • CookiesConfig (dict) – [REQUIRED]

    The cookies from viewer requests to include in origin requests.

    • CookieBehavior (string) – [REQUIRED]

      Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

      • none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.

      • whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

      • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

      • allExcept – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

    • Cookies (dict) –

      Contains a list of cookie names.

      • Quantity (integer) – [REQUIRED]

        The number of cookie names in the Items list.

      • Items (list) –

        A list of cookie names.

        • (string) –

  • QueryStringsConfig (dict) – [REQUIRED]

    The URL query strings from viewer requests to include in origin requests.

    • QueryStringBehavior (string) – [REQUIRED]

      Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

      • none – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.

      • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

      • all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

      • allExcept – All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.

    • QueryStrings (dict) –

      Contains the specific query strings in viewer requests that either are or are not included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the OriginRequestPolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

      • Quantity (integer) – [REQUIRED]

        The number of query string names in the Items list.

      • Items (list) –

        A list of query string names.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'OriginRequestPolicy': {
        'Id': 'string',
        'LastModifiedTime': datetime(2015, 1, 1),
        'OriginRequestPolicyConfig': {
            'Comment': 'string',
            'Name': 'string',
            'HeadersConfig': {
                'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront'|'allExcept',
                'Headers': {
                    'Quantity': 123,
                    'Items': [
                        'string',
                    ]
                }
            },
            'CookiesConfig': {
                'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept',
                'Cookies': {
                    'Quantity': 123,
                    'Items': [
                        'string',
                    ]
                }
            },
            'QueryStringsConfig': {
                'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept',
                'QueryStrings': {
                    'Quantity': 123,
                    'Items': [
                        'string',
                    ]
                }
            }
        }
    },
    'Location': 'string',
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • OriginRequestPolicy (dict) –

      An origin request policy.

      • Id (string) –

        The unique identifier for the origin request policy.

      • LastModifiedTime (datetime) –

        The date and time when the origin request policy was last modified.

      • OriginRequestPolicyConfig (dict) –

        The origin request policy configuration.

        • Comment (string) –

          A comment to describe the origin request policy. The comment cannot be longer than 128 characters.

        • Name (string) –

          A unique name to identify the origin request policy.

        • HeadersConfig (dict) –

          The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

          • HeaderBehavior (string) –

            Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:

            • none – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in a CachePolicy are included in origin requests.

            • whitelist – Only the HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.

            • allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.

            • allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.

            • allExcept – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the Headers type, which are not included.

          • Headers (dict) –

            Contains a list of HTTP header names.

            • Quantity (integer) –

              The number of header names in the Items list.

            • Items (list) –

              A list of HTTP header names.

              • (string) –

        • CookiesConfig (dict) –

          The cookies from viewer requests to include in origin requests.

          • CookieBehavior (string) –

            Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

            • none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.

            • whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

            • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

            • allExcept – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

          • Cookies (dict) –

            Contains a list of cookie names.

            • Quantity (integer) –

              The number of cookie names in the Items list.

            • Items (list) –

              A list of cookie names.

              • (string) –

        • QueryStringsConfig (dict) –

          The URL query strings from viewer requests to include in origin requests.

          • QueryStringBehavior (string) –

            Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

            • none – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.

            • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

            • all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

            • allExcept – All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.

          • QueryStrings (dict) –

            Contains the specific query strings in viewer requests that either are or are not included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the OriginRequestPolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

            • Quantity (integer) –

              The number of query string names in the Items list.

            • Items (list) –

              A list of query string names.

              • (string) –

    • Location (string) –

      The fully qualified URI of the origin request policy just created.

    • ETag (string) –

      The current version of the origin request policy.

Exceptions

  • CloudFront.Client.exceptions.AccessDenied

  • CloudFront.Client.exceptions.InconsistentQuantities

  • CloudFront.Client.exceptions.InvalidArgument

  • CloudFront.Client.exceptions.OriginRequestPolicyAlreadyExists

  • CloudFront.Client.exceptions.TooManyOriginRequestPolicies

  • CloudFront.Client.exceptions.TooManyHeadersInOriginRequestPolicy

  • CloudFront.Client.exceptions.TooManyCookiesInOriginRequestPolicy

  • CloudFront.Client.exceptions.TooManyQueryStringsInOriginRequestPolicy