software.amazon.awscdk.services.cloudfront.origins

Class HttpOrigin.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.origins.HttpOrigin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpOrigin>

Enclosing class:

HttpOrigin

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

A fluent builder for HttpOrigin.

Method Summary

Modifier and Type	Method and Description
HttpOrigin	build()
HttpOrigin.Builder	connectionAttempts(Number connectionAttempts) The number of times that CloudFront attempts to connect to the origin;
HttpOrigin.Builder	connectionTimeout(Duration connectionTimeout) The number of seconds that CloudFront waits when trying to establish a connection to the origin.
static HttpOrigin.Builder	create(String domainName)
HttpOrigin.Builder	customHeaders(Map<String,String> customHeaders) A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.
HttpOrigin.Builder	httpPort(Number httpPort) The HTTP port that CloudFront uses to connect to the origin.
HttpOrigin.Builder	httpsPort(Number httpsPort) The HTTPS port that CloudFront uses to connect to the origin.
HttpOrigin.Builder	keepaliveTimeout(Duration keepaliveTimeout) Specifies how long, in seconds, CloudFront persists its connection to the origin.
HttpOrigin.Builder	originPath(String originPath) An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
HttpOrigin.Builder	originShieldRegion(String originShieldRegion) When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.
HttpOrigin.Builder	originSslProtocols(List<? extends OriginSslPolicy> originSslProtocols) The SSL versions to use when interacting with the origin.
HttpOrigin.Builder	protocolPolicy(OriginProtocolPolicy protocolPolicy) Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
HttpOrigin.Builder	readTimeout(Duration readTimeout) Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static HttpOrigin.Builder create(String domainName)

Parameters:

domainName - This parameter is required.

Returns:

a new instance of HttpOrigin.Builder.

connectionAttempts

@Stability(value=Stable)
public HttpOrigin.Builder connectionAttempts(Number connectionAttempts)

The number of times that CloudFront attempts to connect to the origin;

valid values are 1, 2, or 3 attempts.

Default: 3

Parameters:

connectionAttempts - The number of times that CloudFront attempts to connect to the origin;. This parameter is required.

Returns:

this

connectionTimeout

@Stability(value=Stable)
public HttpOrigin.Builder connectionTimeout(Duration connectionTimeout)

The number of seconds that CloudFront waits when trying to establish a connection to the origin.

Valid values are 1-10 seconds, inclusive.

Default: Duration.seconds(10)

Parameters:

connectionTimeout - The number of seconds that CloudFront waits when trying to establish a connection to the origin. This parameter is required.

Returns:

this

customHeaders

@Stability(value=Stable)
public HttpOrigin.Builder customHeaders(Map<String,String> customHeaders)

A list of HTTP header names and values that CloudFront adds to requests it sends to the origin.

Default: {}

Parameters:

customHeaders - A list of HTTP header names and values that CloudFront adds to requests it sends to the origin. This parameter is required.

Returns:

this

originShieldRegion

@Stability(value=Stable)
public HttpOrigin.Builder originShieldRegion(String originShieldRegion)

When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance.

Default: - origin shield not enabled

Parameters:

originShieldRegion - When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html

originPath

@Stability(value=Stable)
public HttpOrigin.Builder originPath(String originPath)

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

Must begin, but not end, with '/' (e.g., '/production/images').

Default: '/'

Parameters:

originPath - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. This parameter is required.

Returns:

this

httpPort

@Stability(value=Stable)
public HttpOrigin.Builder httpPort(Number httpPort)

The HTTP port that CloudFront uses to connect to the origin.

Default: 80

Parameters:

httpPort - The HTTP port that CloudFront uses to connect to the origin. This parameter is required.

Returns:

this

httpsPort

@Stability(value=Stable)
public HttpOrigin.Builder httpsPort(Number httpsPort)

The HTTPS port that CloudFront uses to connect to the origin.

Default: 443

Parameters:

httpsPort - The HTTPS port that CloudFront uses to connect to the origin. This parameter is required.

Returns:

this

keepaliveTimeout

@Stability(value=Stable)
public HttpOrigin.Builder keepaliveTimeout(Duration keepaliveTimeout)

Specifies how long, in seconds, CloudFront persists its connection to the origin.

The valid range is from 1 to 180 seconds, inclusive.

Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

Default: Duration.seconds(5)

Parameters:

keepaliveTimeout - Specifies how long, in seconds, CloudFront persists its connection to the origin. This parameter is required.

Returns:

this

originSslProtocols

@Stability(value=Stable)
public HttpOrigin.Builder originSslProtocols(List<? extends OriginSslPolicy> originSslProtocols)

The SSL versions to use when interacting with the origin.

Default: OriginSslPolicy.TLS_V1_2

Parameters:

originSslProtocols - The SSL versions to use when interacting with the origin. This parameter is required.

Returns:

this

protocolPolicy

@Stability(value=Stable)
public HttpOrigin.Builder protocolPolicy(OriginProtocolPolicy protocolPolicy)

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.

Default: OriginProtocolPolicy.HTTPS_ONLY

Parameters:

protocolPolicy - Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. This parameter is required.

Returns:

this

readTimeout

@Stability(value=Stable)
public HttpOrigin.Builder readTimeout(Duration readTimeout)

Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

The valid range is from 1 to 180 seconds, inclusive.

Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

Default: Duration.seconds(30)

Parameters:

readTimeout - Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public HttpOrigin build()

Specified by:

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