software.amazon.awscdk.services.cloudfront.origins

Class S3OriginProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<S3OriginProps>

Enclosing interface:

S3OriginProps

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

A builder for S3OriginProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
S3OriginProps	build() Builds the configured instance.
S3OriginProps.Builder	connectionAttempts(Number connectionAttempts) Sets the value of OriginOptions.getConnectionAttempts()
S3OriginProps.Builder	connectionTimeout(Duration connectionTimeout) Sets the value of OriginOptions.getConnectionTimeout()
S3OriginProps.Builder	customHeaders(Map<String,String> customHeaders) Sets the value of OriginOptions.getCustomHeaders()
S3OriginProps.Builder	originAccessIdentity(IOriginAccessIdentity originAccessIdentity) Sets the value of S3OriginProps.getOriginAccessIdentity()
S3OriginProps.Builder	originPath(String originPath) Sets the value of OriginProps.getOriginPath()
S3OriginProps.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 Detail

Builder

public Builder()

Method Detail

originAccessIdentity

@Stability(value=Stable)
public S3OriginProps.Builder originAccessIdentity(IOriginAccessIdentity originAccessIdentity)

Sets the value of S3OriginProps.getOriginAccessIdentity()

Parameters:

originAccessIdentity - An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket.

Returns:

this

originPath

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of S3OriginProps

Throws:

NullPointerException - if any required attribute was not provided