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

Class S3BucketOriginBaseProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<S3BucketOriginBaseProps>

Enclosing interface:

S3BucketOriginBaseProps

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

A builder for S3BucketOriginBaseProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
S3BucketOriginBaseProps	build()	Builds the configured instance.
S3BucketOriginBaseProps.Builder	connectionAttempts(Number connectionAttempts)	Sets the value of OriginOptions.getConnectionAttempts()
S3BucketOriginBaseProps.Builder	connectionTimeout(Duration connectionTimeout)	Sets the value of OriginOptions.getConnectionTimeout()
S3BucketOriginBaseProps.Builder	customHeaders(Map<String,String> customHeaders)	Sets the value of OriginOptions.getCustomHeaders()
S3BucketOriginBaseProps.Builder	originAccessControlId(String originAccessControlId)	Sets the value of OriginOptions.getOriginAccessControlId()
S3BucketOriginBaseProps.Builder	originId(String originId)	Sets the value of OriginOptions.getOriginId()
S3BucketOriginBaseProps.Builder	originPath(String originPath)	Sets the value of OriginProps.getOriginPath()
S3BucketOriginBaseProps.Builder	originShieldEnabled(Boolean originShieldEnabled)	Sets the value of OriginOptions.getOriginShieldEnabled()
S3BucketOriginBaseProps.Builder	originShieldRegion(String originShieldRegion)	Sets the value of OriginOptions.getOriginShieldRegion()

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

originPath

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of S3BucketOriginBaseProps

Throws:

NullPointerException - if any required attribute was not provided