Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudfront
  5. OriginRequestPolicy

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudfront.OriginRequestPolicy

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

An origin request policy. 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 an 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.

Create OriginRequestPolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new OriginRequestPolicy(name: string, args: OriginRequestPolicyArgs, opts?: CustomResourceOptions);
@overload
def OriginRequestPolicy(resource_name: str,
                        args: OriginRequestPolicyArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def OriginRequestPolicy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        origin_request_policy_config: Optional[OriginRequestPolicyConfigArgs] = None)
func NewOriginRequestPolicy(ctx *Context, name string, args OriginRequestPolicyArgs, opts ...ResourceOption) (*OriginRequestPolicy, error)
public OriginRequestPolicy(string name, OriginRequestPolicyArgs args, CustomResourceOptions? opts = null)
public OriginRequestPolicy(String name, OriginRequestPolicyArgs args)
public OriginRequestPolicy(String name, OriginRequestPolicyArgs args, CustomResourceOptions options)

type: aws-native:cloudfront:OriginRequestPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OriginRequestPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OriginRequestPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OriginRequestPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OriginRequestPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OriginRequestPolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

OriginRequestPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The OriginRequestPolicy resource accepts the following input properties:

OriginRequestPolicyConfig This property is required. Pulumi.AwsNative.CloudFront.Inputs.OriginRequestPolicyConfig
The origin request policy configuration.
OriginRequestPolicyConfig This property is required. OriginRequestPolicyConfigArgs
The origin request policy configuration.
originRequestPolicyConfig This property is required. OriginRequestPolicyConfig
The origin request policy configuration.
originRequestPolicyConfig This property is required. OriginRequestPolicyConfig
The origin request policy configuration.
origin_request_policy_config This property is required. OriginRequestPolicyConfigArgs
The origin request policy configuration.
originRequestPolicyConfig This property is required. Property Map
The origin request policy configuration.

Outputs

All input properties are implicitly available as output properties. Additionally, the OriginRequestPolicy resource produces the following output properties:

AwsId string
The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedTime string
The date and time when the origin request policy was last modified.
AwsId string
The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedTime string
The date and time when the origin request policy was last modified.
awsId String
The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
id String
The provider-assigned unique ID for this managed resource.
lastModifiedTime String
The date and time when the origin request policy was last modified.
awsId string
The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
id string
The provider-assigned unique ID for this managed resource.
lastModifiedTime string
The date and time when the origin request policy was last modified.
aws_id str
The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
id str
The provider-assigned unique ID for this managed resource.
last_modified_time str
The date and time when the origin request policy was last modified.
awsId String
The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
id String
The provider-assigned unique ID for this managed resource.
lastModifiedTime String
The date and time when the origin request policy was last modified.

Supporting Types

OriginRequestPolicyConfig
, OriginRequestPolicyConfigArgs

CookiesConfig This property is required. Pulumi.AwsNative.CloudFront.Inputs.OriginRequestPolicyCookiesConfig
The cookies from viewer requests to include in origin requests.
HeadersConfig This property is required. Pulumi.AwsNative.CloudFront.Inputs.OriginRequestPolicyHeadersConfig
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
Name This property is required. string
A unique name to identify the origin request policy.
QueryStringsConfig This property is required. Pulumi.AwsNative.CloudFront.Inputs.OriginRequestPolicyQueryStringsConfig
The URL query strings from viewer requests to include in origin requests.
Comment string
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
CookiesConfig This property is required. OriginRequestPolicyCookiesConfig
The cookies from viewer requests to include in origin requests.
HeadersConfig This property is required. OriginRequestPolicyHeadersConfig
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
Name This property is required. string
A unique name to identify the origin request policy.
QueryStringsConfig This property is required. OriginRequestPolicyQueryStringsConfig
The URL query strings from viewer requests to include in origin requests.
Comment string
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
cookiesConfig This property is required. OriginRequestPolicyCookiesConfig
The cookies from viewer requests to include in origin requests.
headersConfig This property is required. OriginRequestPolicyHeadersConfig
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
name This property is required. String
A unique name to identify the origin request policy.
queryStringsConfig This property is required. OriginRequestPolicyQueryStringsConfig
The URL query strings from viewer requests to include in origin requests.
comment String
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
cookiesConfig This property is required. OriginRequestPolicyCookiesConfig
The cookies from viewer requests to include in origin requests.
headersConfig This property is required. OriginRequestPolicyHeadersConfig
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
name This property is required. string
A unique name to identify the origin request policy.
queryStringsConfig This property is required. OriginRequestPolicyQueryStringsConfig
The URL query strings from viewer requests to include in origin requests.
comment string
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
cookies_config This property is required. OriginRequestPolicyCookiesConfig
The cookies from viewer requests to include in origin requests.
headers_config This property is required. OriginRequestPolicyHeadersConfig
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
name This property is required. str
A unique name to identify the origin request policy.
query_strings_config This property is required. OriginRequestPolicyQueryStringsConfig
The URL query strings from viewer requests to include in origin requests.
comment str
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
cookiesConfig This property is required. Property Map
The cookies from viewer requests to include in origin requests.
headersConfig This property is required. Property Map
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
name This property is required. String
A unique name to identify the origin request policy.
queryStringsConfig This property is required. Property Map
The URL query strings from viewer requests to include in origin requests.
comment String
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.

OriginRequestPolicyCookiesConfig
, OriginRequestPolicyCookiesConfigArgs

CookieBehavior This property is required. 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 List<string>
Contains a list of cookie names.
CookieBehavior This property is required. 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 []string
Contains a list of cookie names.
cookieBehavior This property is required. 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 List<String>
Contains a list of cookie names.
cookieBehavior This property is required. 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 string[]
Contains a list of cookie names.
cookie_behavior This property is required. str
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 Sequence[str]
Contains a list of cookie names.
cookieBehavior This property is required. 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 List<String>
Contains a list of cookie names.

OriginRequestPolicyHeadersConfig
, OriginRequestPolicyHeadersConfigArgs

HeaderBehavior This property is required. 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 List<string>
Contains a list of HTTP header names.
HeaderBehavior This property is required. 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 []string
Contains a list of HTTP header names.
headerBehavior This property is required. 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 List<String>
Contains a list of HTTP header names.
headerBehavior This property is required. 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 string[]
Contains a list of HTTP header names.
header_behavior This property is required. str
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 Sequence[str]
Contains a list of HTTP header names.
headerBehavior This property is required. 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 List<String>
Contains a list of HTTP header names.

OriginRequestPolicyQueryStringsConfig
, OriginRequestPolicyQueryStringsConfigArgs

QueryStringBehavior This property is required. 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 List<string>
Contains a list of query string names.
QueryStringBehavior This property is required. 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 []string
Contains a list of query string names.
queryStringBehavior This property is required. 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 List<String>
Contains a list of query string names.
queryStringBehavior This property is required. 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 string[]
Contains a list of query string names.
query_string_behavior This property is required. str
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.
query_strings Sequence[str]
Contains a list of query string names.
queryStringBehavior This property is required. 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 List<String>
Contains a list of query string names.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native