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

Class VpcOriginWithEndpointProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<VpcOriginWithEndpointProps>

Enclosing interface:

VpcOriginWithEndpointProps

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

A builder for VpcOriginWithEndpointProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

domainName

@Stability(Stable)
public VpcOriginWithEndpointProps.Builder domainName(String domainName)

Sets the value of VpcOriginProps.getDomainName()

Parameters:

domainName - The domain name associated with your VPC origin.

Returns:

this

keepaliveTimeout

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

Sets the value of VpcOriginProps.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(Stable)
public VpcOriginWithEndpointProps.Builder readTimeout(Duration readTimeout)

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

responseCompletionTimeout

@Stability(Stable)
public VpcOriginWithEndpointProps.Builder responseCompletionTimeout(Duration responseCompletionTimeout)

Sets the value of OriginOptions.getResponseCompletionTimeout()

Parameters:

responseCompletionTimeout - The time that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.

Valid values are 1-3600 seconds, inclusive.

Returns:

this

httpPort

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

Sets the value of VpcOriginOptions.getHttpPort()

Parameters:

httpPort - The HTTP port for the CloudFront VPC origin endpoint configuration.

Returns:

this

httpsPort

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

Sets the value of VpcOriginOptions.getHttpsPort()

Parameters:

httpsPort - The HTTPS port of the CloudFront VPC origin endpoint configuration.

Returns:

this

originSslProtocols

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

Sets the value of VpcOriginOptions.getOriginSslProtocols()

Parameters:

originSslProtocols - A list that contains allowed SSL/TLS protocols for this distribution.

Returns:

this

protocolPolicy

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

Sets the value of VpcOriginOptions.getProtocolPolicy()

Parameters:

protocolPolicy - The origin protocol policy for the CloudFront VPC origin endpoint configuration.

Returns:

this

vpcOriginName

@Stability(Stable)
public VpcOriginWithEndpointProps.Builder vpcOriginName(String vpcOriginName)

Sets the value of VpcOriginOptions.getVpcOriginName()

Parameters:

vpcOriginName - The name of the CloudFront VPC origin endpoint configuration.

Returns:

this

build

@Stability(Stable)
public VpcOriginWithEndpointProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of VpcOriginWithEndpointProps

Throws:

NullPointerException - if any required attribute was not provided