Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudfront ]

create-origin-request-policy

Description

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

Synopsis

  create-origin-request-policy
--origin-request-policy-config <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--origin-request-policy-config (structure)

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)

A unique name to identify the origin request policy.

HeadersConfig -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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)

JSON Syntax:

{
  "Comment": "string",
  "Name": "string",
  "HeadersConfig": {
    "HeaderBehavior": "none"|"whitelist"|"allViewer"|"allViewerAndWhitelistCloudFront"|"allExcept",
    "Headers": {
      "Quantity": integer,
      "Items": ["string", ...]
    }
  },
  "CookiesConfig": {
    "CookieBehavior": "none"|"whitelist"|"all"|"allExcept",
    "Cookies": {
      "Quantity": integer,
      "Items": ["string", ...]
    }
  },
  "QueryStringsConfig": {
    "QueryStringBehavior": "none"|"whitelist"|"all"|"allExcept",
    "QueryStrings": {
      "Quantity": integer,
      "Items": ["string", ...]
    }
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

OriginRequestPolicy -> (structure)

An origin request policy.

Id -> (string)

The unique identifier for the origin request policy.

LastModifiedTime -> (timestamp)

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

OriginRequestPolicyConfig -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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.