Package software.amazon.awscdk.services.cloudfront.origins

Class S3StaticWebsiteOriginProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<S3StaticWebsiteOriginProps>

Enclosing interface:

S3StaticWebsiteOriginProps

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

A builder for S3StaticWebsiteOriginProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
S3StaticWebsiteOriginProps	build()	Builds the configured instance.
S3StaticWebsiteOriginProps.Builder	connectionAttempts(Number connectionAttempts)	Sets the value of OriginOptions.getConnectionAttempts()
S3StaticWebsiteOriginProps.Builder	connectionTimeout(Duration connectionTimeout)	Sets the value of OriginOptions.getConnectionTimeout()
S3StaticWebsiteOriginProps.Builder	customHeaders(Map<String,String> customHeaders)	Sets the value of OriginOptions.getCustomHeaders()
S3StaticWebsiteOriginProps.Builder	httpPort(Number httpPort)	Sets the value of HttpOriginProps.getHttpPort()
S3StaticWebsiteOriginProps.Builder	httpsPort(Number httpsPort)	Sets the value of HttpOriginProps.getHttpsPort()
S3StaticWebsiteOriginProps.Builder	keepaliveTimeout(Duration keepaliveTimeout)	Sets the value of HttpOriginProps.getKeepaliveTimeout()
S3StaticWebsiteOriginProps.Builder	originAccessControlId(String originAccessControlId)	Sets the value of OriginOptions.getOriginAccessControlId()
S3StaticWebsiteOriginProps.Builder	originId(String originId)	Sets the value of OriginOptions.getOriginId()
S3StaticWebsiteOriginProps.Builder	originPath(String originPath)	Sets the value of OriginProps.getOriginPath()
S3StaticWebsiteOriginProps.Builder	originShieldEnabled(Boolean originShieldEnabled)	Sets the value of OriginOptions.getOriginShieldEnabled()
S3StaticWebsiteOriginProps.Builder	originShieldRegion(String originShieldRegion)	Sets the value of OriginOptions.getOriginShieldRegion()
S3StaticWebsiteOriginProps.Builder	originSslProtocols(List<? extends OriginSslPolicy> originSslProtocols)	Sets the value of HttpOriginProps.getOriginSslProtocols()
S3StaticWebsiteOriginProps.Builder	protocolPolicy(OriginProtocolPolicy protocolPolicy)	Sets the value of HttpOriginProps.getProtocolPolicy()
S3StaticWebsiteOriginProps.Builder	readTimeout(Duration readTimeout)	Sets the value of HttpOriginProps.getReadTimeout()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

httpPort

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder httpPort(Number httpPort)

Sets the value of HttpOriginProps.getHttpPort()

Parameters:

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

Returns:

this

httpsPort

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder httpsPort(Number httpsPort)

Sets the value of HttpOriginProps.getHttpsPort()

Parameters:

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

Returns:

this

keepaliveTimeout

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder keepaliveTimeout(Duration keepaliveTimeout)

Sets the value of HttpOriginProps.getKeepaliveTimeout()

Parameters:

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.

Returns:

this

originSslProtocols

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder originSslProtocols(List<? extends OriginSslPolicy> originSslProtocols)

Sets the value of HttpOriginProps.getOriginSslProtocols()

Parameters:

originSslProtocols - The SSL versions to use when interacting with the origin.

Returns:

this

protocolPolicy

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder protocolPolicy(OriginProtocolPolicy protocolPolicy)

Sets the value of HttpOriginProps.getProtocolPolicy()

Parameters:

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

Returns:

this

readTimeout

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder readTimeout(Duration readTimeout)

Sets the value of HttpOriginProps.getReadTimeout()

Parameters:

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.

Returns:

this

originPath

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder originPath(String originPath)

Sets the value of OriginProps.getOriginPath()

Parameters:

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').

Returns:

this

connectionAttempts

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder connectionAttempts(Number connectionAttempts)

Sets the value of OriginOptions.getConnectionAttempts()

Parameters:

connectionAttempts - The number of times that CloudFront attempts to connect to the origin;. valid values are 1, 2, or 3 attempts.

Returns:

this

connectionTimeout

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder connectionTimeout(Duration connectionTimeout)

Sets the value of OriginOptions.getConnectionTimeout()

Parameters:

connectionTimeout - The number of seconds that CloudFront waits when trying to establish a connection to the origin. Valid values are 1-10 seconds, inclusive.

Returns:

this

customHeaders

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder customHeaders(Map<String,String> customHeaders)

Sets the value of OriginOptions.getCustomHeaders()

Parameters:

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

Returns:

this

originAccessControlId

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder originAccessControlId(String originAccessControlId)

Sets the value of OriginOptions.getOriginAccessControlId()

Parameters:

originAccessControlId - The unique identifier of an origin access control for this origin.

Returns:

this

originId

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder originId(String originId)

Sets the value of OriginOptions.getOriginId()

Parameters:

originId - A unique identifier for the origin. This value must be unique within the distribution.

Returns:

this

originShieldEnabled

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder originShieldEnabled(Boolean originShieldEnabled)

Sets the value of OriginOptions.getOriginShieldEnabled()

Parameters:

originShieldEnabled - Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false.

Returns:

this

originShieldRegion

@Stability(Stable)
public S3StaticWebsiteOriginProps.Builder originShieldRegion(String originShieldRegion)

Sets the value of OriginOptions.getOriginShieldRegion()

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.

Returns:

this

build

@Stability(Stable)
public S3StaticWebsiteOriginProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of S3StaticWebsiteOriginProps

Throws:

NullPointerException - if any required attribute was not provided