Class: Aws::CloudFront::Types::OriginRequestPolicyConfig

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass OriginRequestPolicyConfig data as a hash:

{
  comment: "string",
  name: "string", # required
  headers_config: { # required
    header_behavior: "none", # required, accepts none, whitelist, allViewer, allViewerAndWhitelistCloudFront
    headers: {
      quantity: 1, # required
      items: ["string"],
    },
  },
  cookies_config: { # required
    cookie_behavior: "none", # required, accepts none, whitelist, all
    cookies: {
      quantity: 1, # required
      items: ["string"],
    },
  },
  query_strings_config: { # required
    query_string_behavior: "none", # required, accepts none, whitelist, all
    query_strings: {
      quantity: 1, # required
      items: ["string"],
    },
  },
}

An origin request policy configuration.

This configuration 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`.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#commentString

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

Returns:

  • (String)

9868
9869
9870
9871
9872
9873
9874
9875
9876
# File 'lib/aws-sdk-cloudfront/types.rb', line 9868

class OriginRequestPolicyConfig < Struct.new(
  :comment,
  :name,
  :headers_config,
  :cookies_config,
  :query_strings_config)
  SENSITIVE = []
  include Aws::Structure
end

#cookies_configTypes::OriginRequestPolicyCookiesConfig

The cookies from viewer requests to include in origin requests.


9868
9869
9870
9871
9872
9873
9874
9875
9876
# File 'lib/aws-sdk-cloudfront/types.rb', line 9868

class OriginRequestPolicyConfig < Struct.new(
  :comment,
  :name,
  :headers_config,
  :cookies_config,
  :query_strings_config)
  SENSITIVE = []
  include Aws::Structure
end

#headers_configTypes::OriginRequestPolicyHeadersConfig

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


9868
9869
9870
9871
9872
9873
9874
9875
9876
# File 'lib/aws-sdk-cloudfront/types.rb', line 9868

class OriginRequestPolicyConfig < Struct.new(
  :comment,
  :name,
  :headers_config,
  :cookies_config,
  :query_strings_config)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A unique name to identify the origin request policy.

Returns:

  • (String)

9868
9869
9870
9871
9872
9873
9874
9875
9876
# File 'lib/aws-sdk-cloudfront/types.rb', line 9868

class OriginRequestPolicyConfig < Struct.new(
  :comment,
  :name,
  :headers_config,
  :cookies_config,
  :query_strings_config)
  SENSITIVE = []
  include Aws::Structure
end

#query_strings_configTypes::OriginRequestPolicyQueryStringsConfig

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


9868
9869
9870
9871
9872
9873
9874
9875
9876
# File 'lib/aws-sdk-cloudfront/types.rb', line 9868

class OriginRequestPolicyConfig < Struct.new(
  :comment,
  :name,
  :headers_config,
  :cookies_config,
  :query_strings_config)
  SENSITIVE = []
  include Aws::Structure
end