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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.331Z")
 @Stability(value=Stable)
public interface OriginGroupProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for OriginGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 import software.amazon.awscdk.services.cloudfront.origins.*;
 IOrigin origin;
 OriginGroupProps originGroupProps = OriginGroupProps.builder()
         .fallbackOrigin(origin)
         .primaryOrigin(origin)
         // the properties below are optional
         .fallbackStatusCodes(List.of(123))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFallbackOrigin

@Stability(value=Stable)
 @NotNull
IOrigin getFallbackOrigin()

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

getFallbackStatusCodes

@Stability(value=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

getPrimaryOrigin

@Stability(value=Stable)
 @NotNull
IOrigin getPrimaryOrigin()

The primary origin that should serve requests for this group.

builder

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

Returns:

a OriginGroupProps.Builder of OriginGroupProps