Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. cloudfront
  5. OriginRequestPolicy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudfront.OriginRequestPolicy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::CloudFront::OriginRequestPolicy

    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 string
    The unique name of the resource.
    args OriginRequestPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args OriginRequestPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OriginRequestPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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

    The OriginRequestPolicy resource accepts the following input properties:

    OriginRequestPolicyConfig OriginRequestPolicyConfigArgs
    The origin request policy configuration.
    originRequestPolicyConfig OriginRequestPolicyConfig
    The origin request policy configuration.
    originRequestPolicyConfig OriginRequestPolicyConfig
    The origin request policy configuration.
    origin_request_policy_config OriginRequestPolicyConfigArgs
    The origin request policy configuration.
    originRequestPolicyConfig 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 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, OriginRequestPolicyCookiesConfigArgs

    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, OriginRequestPolicyHeadersConfigArgs

    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, OriginRequestPolicyQueryStringsConfigArgs

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native