Class CfnDistribution.OriginGroupProperty
An origin group includes two origins (a primary origin and a secondary origin to failover to) and a failover criteria that you specify.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class OriginGroupProperty : Object, CfnDistribution.IOriginGroupProperty
Syntax (vb)
Public Class OriginGroupProperty
Inherits Object
Implements CfnDistribution.IOriginGroupProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;
var originGroupProperty = new OriginGroupProperty {
FailoverCriteria = new OriginGroupFailoverCriteriaProperty {
StatusCodes = new StatusCodesProperty {
Items = new [] { 123 },
Quantity = 123
}
},
Id = "id",
Members = new OriginGroupMembersProperty {
Items = new [] { new OriginGroupMemberProperty {
OriginId = "originId"
} },
Quantity = 123
},
// the properties below are optional
SelectionCriteria = "selectionCriteria"
};
Synopsis
Constructors
OriginGroupProperty() |
Properties
FailoverCriteria | A complex type that contains information about the failover criteria for an origin group. |
Id | The origin group's ID. |
Members | A complex type that contains information about the origins in an origin group. |
SelectionCriteria | The selection criteria for the origin group. |
Constructors
OriginGroupProperty()
public OriginGroupProperty()
Properties
FailoverCriteria
A complex type that contains information about the failover criteria for an origin group.
public object FailoverCriteria { get; set; }
Property Value
System.Object
Remarks
Id
The origin group's ID.
public string Id { get; set; }
Property Value
System.String
Remarks
Members
A complex type that contains information about the origins in an origin group.
public object Members { get; set; }
Property Value
System.Object
Remarks
SelectionCriteria
The selection criteria for the origin group.
public string SelectionCriteria { get; set; }
Property Value
System.String
Remarks
For more information, see Create an origin group in the Amazon CloudFront Developer Guide .