Package software.amazon.awscdk.services.cloudfront

Class SourceConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.SourceConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SourceConfiguration>

Enclosing interface:

SourceConfiguration

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

A builder for SourceConfiguration

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SourceConfiguration.Builder	behaviors(List<? extends Behavior> behaviors)	Sets the value of SourceConfiguration.getBehaviors()
SourceConfiguration	build()	Builds the configured instance.
SourceConfiguration.Builder	connectionAttempts(Number connectionAttempts)	Sets the value of SourceConfiguration.getConnectionAttempts()
SourceConfiguration.Builder	connectionTimeout(Duration connectionTimeout)	Sets the value of SourceConfiguration.getConnectionTimeout()
SourceConfiguration.Builder	customOriginSource(CustomOriginConfig customOriginSource)	Sets the value of SourceConfiguration.getCustomOriginSource()
SourceConfiguration.Builder	failoverCriteriaStatusCodes(List<? extends FailoverStatusCode> failoverCriteriaStatusCodes)	Sets the value of SourceConfiguration.getFailoverCriteriaStatusCodes()
SourceConfiguration.Builder	failoverCustomOriginSource(CustomOriginConfig failoverCustomOriginSource)	Sets the value of SourceConfiguration.getFailoverCustomOriginSource()
SourceConfiguration.Builder	failoverS3OriginSource(S3OriginConfig failoverS3OriginSource)	Sets the value of SourceConfiguration.getFailoverS3OriginSource()
SourceConfiguration.Builder	originHeaders(Map<String,String> originHeaders)	Deprecated. Use originHeaders on s3OriginSource or customOriginSource
SourceConfiguration.Builder	originPath(String originPath)	Deprecated. Use originPath on s3OriginSource or customOriginSource
SourceConfiguration.Builder	originShieldRegion(String originShieldRegion)	Sets the value of SourceConfiguration.getOriginShieldRegion()
SourceConfiguration.Builder	s3OriginSource(S3OriginConfig s3OriginSource)	Sets the value of SourceConfiguration.getS3OriginSource()

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

behaviors

@Stability(Stable)
public SourceConfiguration.Builder behaviors(List<? extends Behavior> behaviors)

Sets the value of SourceConfiguration.getBehaviors()

Parameters:

behaviors - The behaviors associated with this source. This parameter is required. At least one (default) behavior must be included.

Returns:

this

connectionAttempts

@Stability(Stable)
public SourceConfiguration.Builder connectionAttempts(Number connectionAttempts)

Sets the value of SourceConfiguration.getConnectionAttempts()

Parameters:

connectionAttempts - The number of times that CloudFront attempts to connect to the origin. You can specify 1, 2, or 3 as the number of attempts.

Returns:

this

connectionTimeout

@Stability(Stable)
public SourceConfiguration.Builder connectionTimeout(Duration connectionTimeout)

Sets the value of SourceConfiguration.getConnectionTimeout()

Parameters:

connectionTimeout - The number of seconds that CloudFront waits when trying to establish a connection to the origin. You can specify a number of seconds between 1 and 10 (inclusive).

Returns:

this

customOriginSource

@Stability(Stable)
public SourceConfiguration.Builder customOriginSource(CustomOriginConfig customOriginSource)

Sets the value of SourceConfiguration.getCustomOriginSource()

Parameters:

customOriginSource - A custom origin source - for all non-s3 sources.

Returns:

this

failoverCriteriaStatusCodes

@Stability(Stable)
public SourceConfiguration.Builder failoverCriteriaStatusCodes(List<? extends FailoverStatusCode> failoverCriteriaStatusCodes)

Sets the value of SourceConfiguration.getFailoverCriteriaStatusCodes()

Parameters:

failoverCriteriaStatusCodes - HTTP status code to failover to second origin.

Returns:

this

failoverCustomOriginSource

@Stability(Stable)
public SourceConfiguration.Builder failoverCustomOriginSource(CustomOriginConfig failoverCustomOriginSource)

Sets the value of SourceConfiguration.getFailoverCustomOriginSource()

Parameters:

failoverCustomOriginSource - A custom origin source for failover in case the s3OriginSource returns invalid status code.

Returns:

this

failoverS3OriginSource

@Stability(Stable)
public SourceConfiguration.Builder failoverS3OriginSource(S3OriginConfig failoverS3OriginSource)

Sets the value of SourceConfiguration.getFailoverS3OriginSource()

Parameters:

failoverS3OriginSource - An s3 origin source for failover in case the s3OriginSource returns invalid status code.

Returns:

this

originHeaders

@Stability(Deprecated)
@Deprecated
public SourceConfiguration.Builder originHeaders(Map<String,String> originHeaders)

Deprecated.

Use originHeaders on s3OriginSource or customOriginSource

Sets the value of SourceConfiguration.getOriginHeaders()

Parameters:

originHeaders - Any additional headers to pass to the origin.

Returns:

this

originPath

@Stability(Deprecated)
@Deprecated
public SourceConfiguration.Builder originPath(String originPath)

Deprecated.

Use originPath on s3OriginSource or customOriginSource

Sets the value of SourceConfiguration.getOriginPath()

Parameters:

originPath - The relative path to the origin root to use for sources.

Returns:

this

originShieldRegion

@Stability(Stable)
public SourceConfiguration.Builder originShieldRegion(String originShieldRegion)

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

s3OriginSource

@Stability(Stable)
public SourceConfiguration.Builder s3OriginSource(S3OriginConfig s3OriginSource)

Sets the value of SourceConfiguration.getS3OriginSource()

Parameters:

s3OriginSource - An s3 origin source - if you're using s3 for your assets.

Returns:

this

build

@Stability(Stable)
public SourceConfiguration build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SourceConfiguration

Throws:

NullPointerException - if any required attribute was not provided