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

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudfront.getOriginRequestPolicy

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 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.

    Using getOriginRequestPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOriginRequestPolicy(args: GetOriginRequestPolicyArgs, opts?: InvokeOptions): Promise<GetOriginRequestPolicyResult>
function getOriginRequestPolicyOutput(args: GetOriginRequestPolicyOutputArgs, opts?: InvokeOptions): Output<GetOriginRequestPolicyResult>
    def get_origin_request_policy(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetOriginRequestPolicyResult
def get_origin_request_policy_output(id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetOriginRequestPolicyResult]
    func LookupOriginRequestPolicy(ctx *Context, args *LookupOriginRequestPolicyArgs, opts ...InvokeOption) (*LookupOriginRequestPolicyResult, error)
func LookupOriginRequestPolicyOutput(ctx *Context, args *LookupOriginRequestPolicyOutputArgs, opts ...InvokeOption) LookupOriginRequestPolicyResultOutput

    > Note: This function is named LookupOriginRequestPolicy in the Go SDK.

    public static class GetOriginRequestPolicy 
{
    public static Task<GetOriginRequestPolicyResult> InvokeAsync(GetOriginRequestPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetOriginRequestPolicyResult> Invoke(GetOriginRequestPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOriginRequestPolicyResult> getOriginRequestPolicy(GetOriginRequestPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:cloudfront:getOriginRequestPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    Id string
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    id String
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    id string
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    id str
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    id String
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .

    getOriginRequestPolicy Result

    The following output properties are available:

    Id string
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    LastModifiedTime string
    The date and time when the origin request policy was last modified.
    OriginRequestPolicyConfig Pulumi.AwsNative.CloudFront.Outputs.OriginRequestPolicyConfig
    The origin request policy configuration.
    Id string
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    LastModifiedTime string
    The date and time when the origin request policy was last modified.
    OriginRequestPolicyConfig OriginRequestPolicyConfig
    The origin request policy configuration.
    id String
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    lastModifiedTime String
    The date and time when the origin request policy was last modified.
    originRequestPolicyConfig OriginRequestPolicyConfig
    The origin request policy configuration.
    id string
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    lastModifiedTime string
    The date and time when the origin request policy was last modified.
    originRequestPolicyConfig OriginRequestPolicyConfig
    The origin request policy configuration.
    id str
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    last_modified_time str
    The date and time when the origin request policy was last modified.
    origin_request_policy_config OriginRequestPolicyConfig
    The origin request policy configuration.
    id String
    The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c .
    lastModifiedTime String
    The date and time when the origin request policy was last modified.
    originRequestPolicyConfig Property Map
    The origin request policy configuration.

    Supporting Types

    OriginRequestPolicyConfig

    CookiesConfig Pulumi.AwsNative.CloudFront.Inputs.OriginRequestPolicyCookiesConfig
    The cookies from viewer requests to include in origin requests.
    HeadersConfig 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 string
    A unique name to identify the origin request policy.
    QueryStringsConfig 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 OriginRequestPolicyCookiesConfig
    The cookies from viewer requests to include in origin requests.
    HeadersConfig OriginRequestPolicyHeadersConfig
    The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
    Name string
    A unique name to identify the origin request policy.
    QueryStringsConfig 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 OriginRequestPolicyCookiesConfig
    The cookies from viewer requests to include in origin requests.
    headersConfig OriginRequestPolicyHeadersConfig
    The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
    name String
    A unique name to identify the origin request policy.
    queryStringsConfig 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 OriginRequestPolicyCookiesConfig
    The cookies from viewer requests to include in origin requests.
    headersConfig OriginRequestPolicyHeadersConfig
    The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
    name string
    A unique name to identify the origin request policy.
    queryStringsConfig 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 OriginRequestPolicyCookiesConfig
    The cookies from viewer requests to include in origin requests.
    headers_config OriginRequestPolicyHeadersConfig
    The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
    name str
    A unique name to identify the origin request policy.
    query_strings_config 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 Property Map
    The cookies from viewer requests to include in origin requests.
    headersConfig Property Map
    The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
    name String
    A unique name to identify the origin request policy.
    queryStringsConfig 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

    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 List<string>
    Contains a list of cookie names.
    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 []string
    Contains a list of cookie names.
    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 List<String>
    Contains a list of cookie names.
    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 string[]
    Contains a list of cookie names.
    cookie_behavior 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 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

    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 List<string>
    Contains a list of HTTP header names.
    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 []string
    Contains a list of HTTP header names.
    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 List<String>
    Contains a list of HTTP header names.
    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 string[]
    Contains a list of HTTP header names.
    header_behavior 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 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

    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 List<string>
    Contains a list of query string names.
    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 []string
    Contains a list of query string names.
    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 List<String>
    Contains a list of query string names.
    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 string[]
    Contains a list of query string names.
    query_string_behavior 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 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
    aws-native logo

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native