AWS CDK Reference

Appearance

v2.274.0

OriginRequestPolicyProps Struct ​

Properties for creating a Origin Request Policy.

Source
aws-cloudfront/lib/origin-request-policy.ts

Example ​

ts
// Creating a custom origin request policy for a Distribution -- all parameters optional
declare const bucketOrigin: origins.S3Origin;
const myOriginRequestPolicy = new cloudfront.OriginRequestPolicy(this, 'OriginRequestPolicy', {
  originRequestPolicyName: 'MyPolicy',
  comment: 'A default policy',
  cookieBehavior: cloudfront.OriginRequestCookieBehavior.none(),
  headerBehavior: cloudfront.OriginRequestHeaderBehavior.all('CloudFront-Is-Android-Viewer'),
  queryStringBehavior: cloudfront.OriginRequestQueryStringBehavior.allowList('username'),
});

new cloudfront.Distribution(this, 'myDistCustomPolicy', {
  defaultBehavior: {
    origin: bucketOrigin,
    originRequestPolicy: myOriginRequestPolicy,
  },
});

Properties ​

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#
A comment to describe the origin request policy.

Default: no comment

cookieBehavioroptionalOriginRequestCookieBehaviorcookie_behavioroptionalOriginRequestCookieBehaviorcookieBehavioroptionalOriginRequestCookieBehaviorCookieBehavioroptionalOriginRequestCookieBehaviorCookieBehavioroptionalOriginRequestCookieBehavior#
The cookies from viewer requests to include in origin requests.

Default: OriginRequestCookieBehavior.none()

headerBehavioroptionalOriginRequestHeaderBehaviorheader_behavioroptionalOriginRequestHeaderBehaviorheaderBehavioroptionalOriginRequestHeaderBehaviorHeaderBehavioroptionalOriginRequestHeaderBehaviorHeaderBehavioroptionalOriginRequestHeaderBehavior#
The HTTP headers to include in origin requests.

Default: OriginRequestHeaderBehavior.none()

These can include headers from viewer requests and additional headers added by CloudFront.

originRequestPolicyNameoptionalstringorigin_request_policy_nameoptionalstroriginRequestPolicyNameoptionalStringOriginRequestPolicyNameoptionalstringOriginRequestPolicyNameoptional*string#
A unique name to identify the origin request policy.

Default: generated from the id

The name must only include '-', '_', or alphanumeric characters.

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

Default: OriginRequestQueryStringBehavior.none()