OriginRequestQueryStringBehavior Class
Determines whether any URL query strings in viewer requests (and if so, which query strings) 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,
},
});
Properties
The behavior of query strings -- allow all, none, or only an allow list.
queryStringsstring[]query_stringstyping.List[str]queryStringsList<String>QueryStringsstring[]QueryStrings*[]*string#The query strings to allow, if the behavior is an allow list.
Methods
all(): OriginRequestQueryStringBehavior // chainable@staticmethod def all() -> OriginRequestQueryStringBehaviorpublic static OriginRequestQueryStringBehavior all()public static OriginRequestQueryStringBehavior All()func All() OriginRequestQueryStringBehaviorstatic#All query strings in viewer requests are included in requests that CloudFront sends to the origin.
allowList(...queryStrings: string[]): OriginRequestQueryStringBehavior // chainable@staticmethod def allow_list(query_strings: str) -> OriginRequestQueryStringBehaviorpublic static OriginRequestQueryStringBehavior allowList(String queryStrings)public static OriginRequestQueryStringBehavior AllowList(string queryStrings)func AllowList(QueryStrings *string) OriginRequestQueryStringBehaviorstatic#Only the provided `queryStrings` are included in requests that CloudFront sends to the origin.
denyList(...queryStrings: string[]): OriginRequestQueryStringBehavior // chainable@staticmethod def deny_list(query_strings: str) -> OriginRequestQueryStringBehaviorpublic static OriginRequestQueryStringBehavior denyList(String queryStrings)public static OriginRequestQueryStringBehavior DenyList(string queryStrings)func DenyList(QueryStrings *string) OriginRequestQueryStringBehaviorstatic#All query strings except the provided `queryStrings` are included in requests that CloudFront sends to the origin.
none(): OriginRequestQueryStringBehavior // chainable@staticmethod def none() -> OriginRequestQueryStringBehaviorpublic static OriginRequestQueryStringBehavior none()public static OriginRequestQueryStringBehavior None()func None() OriginRequestQueryStringBehaviorstatic#Query strings in viewer requests are not included in requests that CloudFront sends to the origin.
Any query strings that are listed in a CachePolicy are still included in origin requests.