software.amazon.awscdk.services.cloudfront

Interface OriginFailoverConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OriginFailoverConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.142Z")
 @Stability(value=Stable)
public interface OriginFailoverConfig
extends software.amazon.jsii.JsiiSerializable

The failover configuration used for Origin Groups, returned in OriginBindConfig.failoverConfig.

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.*;
 IOrigin origin;
 OriginFailoverConfig originFailoverConfig = OriginFailoverConfig.builder()
         .failoverOrigin(origin)
         // the properties below are optional
         .statusCodes(List.of(123))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static OriginFailoverConfig.Builder	builder()
IOrigin	getFailoverOrigin() The origin to use as the fallback origin.
default List<Number>	getStatusCodes() The HTTP status codes of the response that trigger querying the failover Origin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFailoverOrigin

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

The origin to use as the fallback origin.

getStatusCodes

@Stability(value=Stable)
 @Nullable
default List<Number> getStatusCodes()

The HTTP status codes of the response that trigger querying the failover Origin.

Default: - 500, 502, 503 and 504

builder

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

Returns:

a OriginFailoverConfig.Builder of OriginFailoverConfig