Skip to content
v2.277.0

OriginRequestHeaderBehavior Class ​

Determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.

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,
  },
});
python
# Creating a custom origin request policy for a Distribution -- all parameters optional
# bucket_origin: origins.S3Origin

my_origin_request_policy = cloudfront.OriginRequestPolicy(self, "OriginRequestPolicy",
    origin_request_policy_name="MyPolicy",
    comment="A default policy",
    cookie_behavior=cloudfront.OriginRequestCookieBehavior.none(),
    header_behavior=cloudfront.OriginRequestHeaderBehavior.all("CloudFront-Is-Android-Viewer"),
    query_string_behavior=cloudfront.OriginRequestQueryStringBehavior.allow_list("username")
)

cloudfront.Distribution(self, "myDistCustomPolicy",
    default_behavior=cloudfront.BehaviorOptions(
        origin=bucket_origin,
        origin_request_policy=my_origin_request_policy
    )
)
java
// Creating a custom origin request policy for a Distribution -- all parameters optional
S3Origin bucketOrigin;

OriginRequestPolicy myOriginRequestPolicy = OriginRequestPolicy.Builder.create(this, "OriginRequestPolicy")
        .originRequestPolicyName("MyPolicy")
        .comment("A default policy")
        .cookieBehavior(OriginRequestCookieBehavior.none())
        .headerBehavior(OriginRequestHeaderBehavior.all("CloudFront-Is-Android-Viewer"))
        .queryStringBehavior(OriginRequestQueryStringBehavior.allowList("username"))
        .build();

Distribution.Builder.create(this, "myDistCustomPolicy")
        .defaultBehavior(BehaviorOptions.builder()
                .origin(bucketOrigin)
                .originRequestPolicy(myOriginRequestPolicy)
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// Creating a custom origin request policy for a Distribution -- all parameters optional
S3Origin bucketOrigin;

var myOriginRequestPolicy = new OriginRequestPolicy(this, "OriginRequestPolicy", new OriginRequestPolicyProps {
    OriginRequestPolicyName = "MyPolicy",
    Comment = "A default policy",
    CookieBehavior = OriginRequestCookieBehavior.None(),
    HeaderBehavior = OriginRequestHeaderBehavior.All("CloudFront-Is-Android-Viewer"),
    QueryStringBehavior = OriginRequestQueryStringBehavior.AllowList("username")
});

new Distribution(this, "myDistCustomPolicy", new DistributionProps {
    DefaultBehavior = new BehaviorOptions {
        Origin = bucketOrigin,
        OriginRequestPolicy = myOriginRequestPolicy
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Creating a custom origin request policy for a Distribution -- all parameters optional
var bucketOrigin S3Origin

myOriginRequestPolicy := cloudfront.NewOriginRequestPolicy(this, jsii.String("OriginRequestPolicy"), &OriginRequestPolicyProps{
	OriginRequestPolicyName: jsii.String("MyPolicy"),
	Comment: jsii.String("A default policy"),
	CookieBehavior: cloudfront.OriginRequestCookieBehavior_None(),
	HeaderBehavior: cloudfront.OriginRequestHeaderBehavior_All(jsii.String("CloudFront-Is-Android-Viewer")),
	QueryStringBehavior: cloudfront.OriginRequestQueryStringBehavior_AllowList(jsii.String("username")),
})

cloudfront.NewDistribution(this, jsii.String("myDistCustomPolicy"), &DistributionProps{
	DefaultBehavior: &BehaviorOptions{
		Origin: bucketOrigin,
		OriginRequestPolicy: myOriginRequestPolicy,
	},
})

Properties ​

behaviorstringbehaviorstrbehaviorStringBehaviorstringBehavior*string #
The behavior of headers: allow all, none or an allow list.
headersmay be undefinedstring[]headersmay be undefinedtyping.List[str]headersmay be undefinedList<String>Headersmay be undefinedstring[]Headersmay be undefined*[]*string #
The headers for the allow list or the included CloudFront headers, if applicable.

Methods ​

all(...cloudfrontHeaders: string[]): OriginRequestHeaderBehavior // chainable@staticmethod def all(cloudfront_headers: str) -> OriginRequestHeaderBehaviorpublic static OriginRequestHeaderBehavior all(String cloudfrontHeaders)public static OriginRequestHeaderBehavior All(string cloudfrontHeaders)func All(CloudfrontHeaders *string) OriginRequestHeaderBehavior static #
All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.

Additionally, any additional CloudFront headers provided are included; the additional headers are added by CloudFront.

allowList(...headers: string[]): OriginRequestHeaderBehavior // chainable@staticmethod def allow_list(headers: str) -> OriginRequestHeaderBehaviorpublic static OriginRequestHeaderBehavior allowList(String headers)public static OriginRequestHeaderBehavior AllowList(string headers)func AllowList(Headers *string) OriginRequestHeaderBehavior static #
Listed headers are included in requests that CloudFront sends to the origin.
denyList(...headers: string[]): OriginRequestHeaderBehavior // chainable@staticmethod def deny_list(headers: str) -> OriginRequestHeaderBehaviorpublic static OriginRequestHeaderBehavior denyList(String headers)public static OriginRequestHeaderBehavior DenyList(string headers)func DenyList(Headers *string) OriginRequestHeaderBehavior static #
All headers except the provided `headers` are included in requests that CloudFront sends to the origin.
none(): OriginRequestHeaderBehavior // chainable@staticmethod def none() -> OriginRequestHeaderBehaviorpublic static OriginRequestHeaderBehavior none()public static OriginRequestHeaderBehavior None()func None() OriginRequestHeaderBehavior static #
HTTP headers are not included in requests that CloudFront sends to the origin.

Any headers that are listed in a CachePolicy are still included in origin requests.