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

Class OriginGroup.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<OriginGroup>

Enclosing class:

OriginGroup

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

A fluent builder for OriginGroup.

Method Summary

Modifier and Type	Method	Description
OriginGroup	build()
static OriginGroup.Builder	create()
OriginGroup.Builder	fallbackOrigin(IOrigin fallbackOrigin)	The fallback origin that should serve requests when the primary fails.
OriginGroup.Builder	fallbackStatusCodes(List<? extends Number> fallbackStatusCodes)	The list of HTTP status codes that, when returned from the primary origin, would cause querying the fallback origin.
OriginGroup.Builder	primaryOrigin(IOrigin primaryOrigin)	The primary origin that should serve requests for this group.
OriginGroup.Builder	selectionCriteria(OriginSelectionCriteria selectionCriteria)	The selection criteria for the origin group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static OriginGroup.Builder create()

Returns:

a new instance of OriginGroup.Builder.

fallbackOrigin

@Stability(Stable)
public OriginGroup.Builder fallbackOrigin(IOrigin fallbackOrigin)

The fallback origin that should serve requests when the primary fails.

Parameters:

fallbackOrigin - The fallback origin that should serve requests when the primary fails. This parameter is required.

Returns:

this

primaryOrigin

@Stability(Stable)
public OriginGroup.Builder primaryOrigin(IOrigin primaryOrigin)

The primary origin that should serve requests for this group.

Parameters:

primaryOrigin - The primary origin that should serve requests for this group. This parameter is required.

Returns:

this

fallbackStatusCodes

@Stability(Stable)
public OriginGroup.Builder fallbackStatusCodes(List<? extends Number> fallbackStatusCodes)

The list of HTTP status codes that, when returned from the primary origin, would cause querying the fallback origin.

Default: - 500, 502, 503 and 504

Parameters:

fallbackStatusCodes - The list of HTTP status codes that, when returned from the primary origin, would cause querying the fallback origin. This parameter is required.

Returns:

this

selectionCriteria

@Stability(Stable)
public OriginGroup.Builder selectionCriteria(OriginSelectionCriteria selectionCriteria)

The selection criteria for the origin group.

Default: - OriginSelectionCriteria.DEFAULT

Parameters:

selectionCriteria - The selection criteria for the origin group. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/high_availability_origin_failover.html#concept_origin_groups.creating

build

@Stability(Stable)
public OriginGroup build()

Specified by:

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

Returns:

a newly built instance of OriginGroup.