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

Interface OriginGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OriginGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-26T23:01:01.347Z")
@Stability(Stable)
public interface OriginGroupProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for OriginGroup.

Example:

 Bucket myBucket = new Bucket(this, "myBucket");
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(OriginGroup.Builder.create()
                         .primaryOrigin(S3BucketOrigin.withOriginAccessControl(myBucket))
                         .fallbackOrigin(new HttpOrigin("www.example.com"))
                         // optional, defaults to: 500, 502, 503 and 504
                         .fallbackStatusCodes(List.of(404))
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OriginGroupProps.Builder	A builder for OriginGroupProps
static final class	OriginGroupProps.Jsii$Proxy	An implementation for OriginGroupProps

Method Summary

Modifier and Type	Method	Description
static OriginGroupProps.Builder	builder()
IOrigin	getFallbackOrigin()	The fallback origin that should serve requests when the primary fails.
default List<Number>	getFallbackStatusCodes()	The list of HTTP status codes that, when returned from the primary origin, would cause querying the fallback origin.
IOrigin	getPrimaryOrigin()	The primary origin that should serve requests for this group.
default OriginSelectionCriteria	getSelectionCriteria()	The selection criteria for the origin group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFallbackOrigin

@Stability(Stable)
@NotNull
IOrigin getFallbackOrigin()

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

getPrimaryOrigin

@Stability(Stable)
@NotNull
IOrigin getPrimaryOrigin()

The primary origin that should serve requests for this group.

getFallbackStatusCodes

@Stability(Stable)
@Nullable
default List<Number> getFallbackStatusCodes()

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

getSelectionCriteria

@Stability(Stable)
@Nullable
default OriginSelectionCriteria getSelectionCriteria()

The selection criteria for the origin group.

Default: - OriginSelectionCriteria.DEFAULT

See Also:

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

builder

@Stability(Stable)
static OriginGroupProps.Builder builder()

Returns:

a OriginGroupProps.Builder of OriginGroupProps