software.amazon.awscdk.services.cloudfront

Interface CfnDistribution.OriginGroupProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistribution.OriginGroupProperty.Jsii$Proxy

Enclosing class:

CfnDistribution

@Stability(value=Stable)
public static interface CfnDistribution.OriginGroupProperty
extends software.amazon.jsii.JsiiSerializable

An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify.

You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specifiy the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.

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.*;
 OriginGroupProperty originGroupProperty = OriginGroupProperty.builder()
         .failoverCriteria(OriginGroupFailoverCriteriaProperty.builder()
                 .statusCodes(StatusCodesProperty.builder()
                         .items(List.of(123))
                         .quantity(123)
                         .build())
                 .build())
         .id("id")
         .members(OriginGroupMembersProperty.builder()
                 .items(List.of(OriginGroupMemberProperty.builder()
                         .originId("originId")
                         .build()))
                 .quantity(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDistribution.OriginGroupProperty.Builder	builder()
Object	getFailoverCriteria() A complex type that contains information about the failover criteria for an origin group.
String	getId() The origin group's ID.
Object	getMembers() A complex type that contains information about the origins in an origin group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFailoverCriteria

@Stability(value=Stable)
 @NotNull
Object getFailoverCriteria()

A complex type that contains information about the failover criteria for an origin group.

getId

@Stability(value=Stable)
 @NotNull
String getId()

The origin group's ID.

getMembers

@Stability(value=Stable)
 @NotNull
Object getMembers()

A complex type that contains information about the origins in an origin group.

builder

@Stability(value=Stable)
static CfnDistribution.OriginGroupProperty.Builder builder()

Returns:

a CfnDistribution.OriginGroupProperty.Builder of CfnDistribution.OriginGroupProperty