software.amazon.awscdk.services.cloudfront

Class OriginRequestPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.OriginRequestPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OriginRequestPolicy>

Enclosing class:

OriginRequestPolicy

@Stability(value=Experimental)
public static final class OriginRequestPolicy.Builder
extends Object
implements software.amazon.jsii.Builder<OriginRequestPolicy>

(experimental) A fluent builder for OriginRequestPolicy.

Method Summary

Modifier and Type	Method and Description
OriginRequestPolicy	build()
OriginRequestPolicy.Builder	comment(String comment) (experimental) A comment to describe the origin request policy.
OriginRequestPolicy.Builder	cookieBehavior(OriginRequestCookieBehavior cookieBehavior) (experimental) The cookies from viewer requests to include in origin requests.
static OriginRequestPolicy.Builder	create(software.constructs.Construct scope, String id)
OriginRequestPolicy.Builder	headerBehavior(OriginRequestHeaderBehavior headerBehavior) (experimental) The HTTP headers to include in origin requests.
OriginRequestPolicy.Builder	originRequestPolicyName(String originRequestPolicyName) (experimental) A unique name to identify the origin request policy.
OriginRequestPolicy.Builder	queryStringBehavior(OriginRequestQueryStringBehavior queryStringBehavior) (experimental) The URL query strings from viewer requests to include in origin requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static OriginRequestPolicy.Builder create(software.constructs.Construct scope,
                                                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of OriginRequestPolicy.Builder.

comment

@Stability(value=Experimental)
public OriginRequestPolicy.Builder comment(String comment)

(experimental) A comment to describe the origin request policy.

Default: - no comment

Parameters:

comment - A comment to describe the origin request policy. This parameter is required.

Returns:

this

cookieBehavior

@Stability(value=Experimental)
public OriginRequestPolicy.Builder cookieBehavior(OriginRequestCookieBehavior cookieBehavior)

(experimental) The cookies from viewer requests to include in origin requests.

Default: OriginRequestCookieBehavior.none()

Parameters:

cookieBehavior - The cookies from viewer requests to include in origin requests. This parameter is required.

Returns:

this

headerBehavior

@Stability(value=Experimental)
public OriginRequestPolicy.Builder headerBehavior(OriginRequestHeaderBehavior headerBehavior)

(experimental) The HTTP headers to include in origin requests.

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

Default: OriginRequestHeaderBehavior.none()

Parameters:

headerBehavior - The HTTP headers to include in origin requests. This parameter is required.

Returns:

this

originRequestPolicyName

@Stability(value=Experimental)
public OriginRequestPolicy.Builder originRequestPolicyName(String originRequestPolicyName)

(experimental) A unique name to identify the origin request policy.

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

Default: - generated from the `id`

Parameters:

originRequestPolicyName - A unique name to identify the origin request policy. This parameter is required.

Returns:

this

queryStringBehavior

@Stability(value=Experimental)
public OriginRequestPolicy.Builder queryStringBehavior(OriginRequestQueryStringBehavior queryStringBehavior)

(experimental) The URL query strings from viewer requests to include in origin requests.

Default: OriginRequestQueryStringBehavior.none()

Parameters:

queryStringBehavior - The URL query strings from viewer requests to include in origin requests. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public OriginRequestPolicy build()

Specified by:

build in interface software.amazon.jsii.Builder<OriginRequestPolicy>