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

Class FunctionUrlOriginWithOACProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<FunctionUrlOriginWithOACProps>

Enclosing interface:

FunctionUrlOriginWithOACProps

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

A builder for FunctionUrlOriginWithOACProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FunctionUrlOriginWithOACProps	build()	Builds the configured instance.
FunctionUrlOriginWithOACProps.Builder	connectionAttempts(Number connectionAttempts)	Sets the value of OriginOptions.getConnectionAttempts()
FunctionUrlOriginWithOACProps.Builder	connectionTimeout(Duration connectionTimeout)	Sets the value of OriginOptions.getConnectionTimeout()
FunctionUrlOriginWithOACProps.Builder	customHeaders(Map<String,String> customHeaders)	Sets the value of OriginOptions.getCustomHeaders()
FunctionUrlOriginWithOACProps.Builder	keepaliveTimeout(Duration keepaliveTimeout)	Sets the value of FunctionUrlOriginProps.getKeepaliveTimeout()
FunctionUrlOriginWithOACProps.Builder	originAccessControl(IOriginAccessControl originAccessControl)	Sets the value of FunctionUrlOriginWithOACProps.getOriginAccessControl()
FunctionUrlOriginWithOACProps.Builder	originAccessControlId(String originAccessControlId)	Sets the value of OriginOptions.getOriginAccessControlId()
FunctionUrlOriginWithOACProps.Builder	originId(String originId)	Sets the value of OriginOptions.getOriginId()
FunctionUrlOriginWithOACProps.Builder	originPath(String originPath)	Sets the value of OriginProps.getOriginPath()
FunctionUrlOriginWithOACProps.Builder	originShieldEnabled(Boolean originShieldEnabled)	Sets the value of OriginOptions.getOriginShieldEnabled()
FunctionUrlOriginWithOACProps.Builder	originShieldRegion(String originShieldRegion)	Sets the value of OriginOptions.getOriginShieldRegion()
FunctionUrlOriginWithOACProps.Builder	readTimeout(Duration readTimeout)	Sets the value of FunctionUrlOriginProps.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

originAccessControl

@Stability(Stable)
public FunctionUrlOriginWithOACProps.Builder originAccessControl(IOriginAccessControl originAccessControl)

Sets the value of FunctionUrlOriginWithOACProps.getOriginAccessControl()

Parameters:

originAccessControl - An optional Origin Access Control.

Returns:

this

keepaliveTimeout

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

Sets the value of FunctionUrlOriginProps.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 FunctionUrlOriginWithOACProps.Builder readTimeout(Duration readTimeout)

Sets the value of FunctionUrlOriginProps.getReadTimeout()

Parameters:

readTimeout - Specifies how long, in seconds, CloudFront waits for a response from 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

originPath

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of FunctionUrlOriginWithOACProps

Throws:

NullPointerException - if any required attribute was not provided