aws-native.cloudfront.OriginRequestPolicy

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

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:

Outputs

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

Supporting Types

OriginRequestPolicyConfig, OriginRequestPolicyConfigArgs

OriginRequestPolicyCookiesConfig, OriginRequestPolicyCookiesConfigArgs

OriginRequestPolicyHeadersConfig, OriginRequestPolicyHeadersConfigArgs

OriginRequestPolicyQueryStringsConfig, OriginRequestPolicyQueryStringsConfigArgs

Package Details

Repository

AWS Native pulumi/pulumi-aws-native

License

Apache-2.0