Interface CfnDistribution.OriginGroupProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDistribution.OriginGroupProperty.Jsii$Proxy
- Enclosing class:
CfnDistribution
@Stability(Stable)
public static interface CfnDistribution.OriginGroupProperty
extends software.amazon.jsii.JsiiSerializable
An origin group includes two origins (a primary origin and a secondary 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 specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen.
Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.
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()) // the properties below are optional .selectionCriteria("selectionCriteria") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDistribution.OriginGroupProperty
static final class
An implementation forCfnDistribution.OriginGroupProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
A complex type that contains information about the failover criteria for an origin group.getId()
The origin group's ID.A complex type that contains information about the origins in an origin group.default String
The selection criteria for the origin group.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getFailoverCriteria
A complex type that contains information about the failover criteria for an origin group.- See Also:
-
getId
The origin group's ID.- See Also:
-
getMembers
A complex type that contains information about the origins in an origin group.- See Also:
-
getSelectionCriteria
The selection criteria for the origin group.For more information, see Create an origin group in the Amazon CloudFront Developer Guide .
- See Also:
-
builder
-