software.amazon.awscdk.services.cloudfront.origins

Class RestApiOriginProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<RestApiOriginProps>

Enclosing interface:

RestApiOriginProps

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

A builder for RestApiOriginProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RestApiOriginProps	build() Builds the configured instance.
RestApiOriginProps.Builder	connectionAttempts(Number connectionAttempts) Sets the value of OriginOptions.getConnectionAttempts()
RestApiOriginProps.Builder	connectionTimeout(Duration connectionTimeout) Sets the value of OriginOptions.getConnectionTimeout()
RestApiOriginProps.Builder	customHeaders(Map<String,String> customHeaders) Sets the value of OriginOptions.getCustomHeaders()
RestApiOriginProps.Builder	keepaliveTimeout(Duration keepaliveTimeout) Sets the value of RestApiOriginProps.getKeepaliveTimeout()
RestApiOriginProps.Builder	originShieldRegion(String originShieldRegion) Sets the value of OriginOptions.getOriginShieldRegion()
RestApiOriginProps.Builder	readTimeout(Duration readTimeout) Sets the value of RestApiOriginProps.getReadTimeout()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

keepaliveTimeout

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

Sets the value of RestApiOriginProps.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

readTimeout

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

Sets the value of RestApiOriginProps.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

connectionAttempts

@Stability(value=Stable)
public RestApiOriginProps.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(value=Stable)
public RestApiOriginProps.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(value=Stable)
public RestApiOriginProps.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

originShieldRegion

@Stability(value=Stable)
public RestApiOriginProps.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(value=Stable)
public RestApiOriginProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of RestApiOriginProps

Throws:

NullPointerException - if any required attribute was not provided