software.amazon.awscdk.services.cloudfront.origins

Class OriginGroup

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

IOrigin, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.176Z")
 @Stability(value=Stable)
public class OriginGroup
extends software.amazon.jsii.JsiiObject
implements IOrigin

An Origin that represents a group.

Consists of a primary Origin, and a fallback Origin called when the primary returns one of the provided HTTP status codes.

Example:

 Bucket myBucket = new Bucket(this, "myBucket");
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(OriginGroup.Builder.create()
                         .primaryOrigin(new S3Origin(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	Class and Description
static class	OriginGroup.Builder A fluent builder for OriginGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudfront.IOrigin

IOrigin.Jsii$Default, IOrigin.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OriginGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	OriginGroup(software.amazon.jsii.JsiiObjectRef objRef)
	OriginGroup(OriginGroupProps props)

Method Summary

Modifier and Type	Method and Description
OriginBindConfig	bind(software.constructs.Construct scope, OriginBindOptions options) The method called when a given Origin is added (for the first time) to a Distribution.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

OriginGroup

protected OriginGroup(software.amazon.jsii.JsiiObjectRef objRef)

OriginGroup

protected OriginGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

OriginGroup

@Stability(value=Stable)
public OriginGroup(@NotNull
                                            OriginGroupProps props)

Parameters:

props - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public OriginBindConfig bind(@NotNull
                                                                software.constructs.Construct scope,
                                                                @NotNull
                                                                OriginBindOptions options)

The method called when a given Origin is added (for the first time) to a Distribution.

Specified by:

bind in interface IOrigin

Parameters:

scope - This parameter is required.

options - This parameter is required.