Class OriginRequestPolicy

A Origin Request Policy configuration.

Inheritance

object

Resource

OriginRequestPolicy

Implements

IResource

IConstruct

IDependable

IOriginRequestPolicy

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class OriginRequestPolicy : Resource, IResource, IConstruct, IDependable, IOriginRequestPolicy

Syntax (vb)

Public Class OriginRequestPolicy Inherits Resource Implements IResource, IConstruct, IDependable, IOriginRequestPolicy

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

Examples

// Using an existing origin request policy for a Distribution
             S3Origin bucketOrigin;

             new Distribution(this, "myDistManagedPolicy", new DistributionProps {
                 DefaultBehavior = new BehaviorOptions {
                     Origin = bucketOrigin,
                     OriginRequestPolicy = OriginRequestPolicy.CORS_S3_ORIGIN
                 }
             });

Synopsis

Constructors

OriginRequestPolicy(Construct, string, IOriginRequestPolicyProps?)

A Origin Request Policy configuration.

Properties

ALL_VIEWER	This policy includes all values (query strings, headers, and cookies) in the viewer request.
ALL_VIEWER_AND_CLOUDFRONT_2022	This policy includes all values (headers, cookies, and query strings) in the viewer request, and all CloudFront headers that were released through June 2022 (CloudFront headers released after June 2022 are not included).
ALL_VIEWER_EXCEPT_HOST_HEADER	This policy includes all values (query strings, and cookies) except the header in the viewer request.
CORS_CUSTOM_ORIGIN	This policy includes the header that enables cross-origin resource sharing (CORS) requests when the origin is a custom origin.
CORS_S3_ORIGIN	This policy includes the headers that enable cross-origin resource sharing (CORS) requests when the origin is an Amazon S3 bucket.
ELEMENTAL_MEDIA_TAILOR	This policy is designed for use with an origin that is an AWS Elemental MediaTailor endpoint.
OriginRequestPolicyId	The ID of the origin request policy.
PROPERTY_INJECTION_ID	Uniquely identifies this class.
USER_AGENT_REFERER_HEADERS	This policy includes only the User-Agent and Referer headers.

Methods

FromOriginRequestPolicyId(Construct, string, string)

Imports a Origin Request Policy from its id.

Constructors

OriginRequestPolicy(Construct, string, IOriginRequestPolicyProps?)

A Origin Request Policy configuration.

public OriginRequestPolicy(Construct scope, string id, IOriginRequestPolicyProps? props = null)

Parameters

scope Construct

id string

props IOriginRequestPolicyProps

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

Examples

// Using an existing origin request policy for a Distribution
             S3Origin bucketOrigin;

             new Distribution(this, "myDistManagedPolicy", new DistributionProps {
                 DefaultBehavior = new BehaviorOptions {
                     Origin = bucketOrigin,
                     OriginRequestPolicy = OriginRequestPolicy.CORS_S3_ORIGIN
                 }
             });

Properties

ALL_VIEWER

This policy includes all values (query strings, headers, and cookies) in the viewer request.

public static IOriginRequestPolicy ALL_VIEWER { get; }

Property Value

IOriginRequestPolicy

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

ALL_VIEWER_AND_CLOUDFRONT_2022

This policy includes all values (headers, cookies, and query strings) in the viewer request, and all CloudFront headers that were released through June 2022 (CloudFront headers released after June 2022 are not included).

public static IOriginRequestPolicy ALL_VIEWER_AND_CLOUDFRONT_2022 { get; }

Property Value

IOriginRequestPolicy

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

ALL_VIEWER_EXCEPT_HOST_HEADER

This policy includes all values (query strings, and cookies) except the header in the viewer request.

public static IOriginRequestPolicy ALL_VIEWER_EXCEPT_HOST_HEADER { get; }

Property Value

IOriginRequestPolicy

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

CORS_CUSTOM_ORIGIN

This policy includes the header that enables cross-origin resource sharing (CORS) requests when the origin is a custom origin.

public static IOriginRequestPolicy CORS_CUSTOM_ORIGIN { get; }

Property Value

IOriginRequestPolicy

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

CORS_S3_ORIGIN

This policy includes the headers that enable cross-origin resource sharing (CORS) requests when the origin is an Amazon S3 bucket.

public static IOriginRequestPolicy CORS_S3_ORIGIN { get; }

Property Value

IOriginRequestPolicy

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

ELEMENTAL_MEDIA_TAILOR

This policy is designed for use with an origin that is an AWS Elemental MediaTailor endpoint.

public static IOriginRequestPolicy ELEMENTAL_MEDIA_TAILOR { get; }

Property Value

IOriginRequestPolicy

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

OriginRequestPolicyId

The ID of the origin request policy.

public virtual string OriginRequestPolicyId { get; }

Property Value

string

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

USER_AGENT_REFERER_HEADERS

This policy includes only the User-Agent and Referer headers.

public static IOriginRequestPolicy USER_AGENT_REFERER_HEADERS { get; }

Property Value

IOriginRequestPolicy

Remarks

It doesn’t include any query strings or cookies.

Methods

FromOriginRequestPolicyId(Construct, string, string)

Imports a Origin Request Policy from its id.

public static IOriginRequestPolicy FromOriginRequestPolicyId(Construct scope, string id, string originRequestPolicyId)

Parameters

scope Construct

id string

originRequestPolicyId string

Returns

IOriginRequestPolicy

Remarks

Resource: AWS::CloudFront::OriginRequestPolicy

ExampleMetadata: infused

Implements

IResource

Constructs.IConstruct

Constructs.IDependable

IOriginRequestPolicy