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

object

CfnDistribution.OriginGroupProperty

Implements

CfnDistribution.IOriginGroupProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDistribution.OriginGroupProperty : CfnDistribution.IOriginGroupProperty

Syntax (vb)

Public Class CfnDistribution.OriginGroupProperty 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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html

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()

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

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()

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

public OriginGroupProperty()

Remarks

Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html

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"
             };

Properties

FailoverCriteria

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

public object FailoverCriteria { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-failovercriteria

Type union: either IResolvable or CfnDistribution.IOriginGroupFailoverCriteriaProperty

Id

The origin group's ID.

public string Id { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-id

Members

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

public object Members { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-members

Type union: either IResolvable or CfnDistribution.IOriginGroupMembersProperty

SelectionCriteria

The selection criteria for the origin group.

public string? SelectionCriteria { get; set; }

Property Value

string

Remarks

For more information, see Create an origin group in the Amazon CloudFront Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroup.html#cfn-cloudfront-distribution-origingroup-selectioncriteria

Implements

CfnDistribution.IOriginGroupProperty