aws-cdk-lib.aws_cloudfront.CfnDistribution.OriginGroupProperty

interface OriginGroupProperty

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.CfnDistribution.OriginGroupProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnDistribution_OriginGroupProperty
Javasoftware.amazon.awscdk.services.cloudfront.CfnDistribution.OriginGroupProperty
Pythonaws_cdk.aws_cloudfront.CfnDistribution.OriginGroupProperty
TypeScript aws-cdk-lib » aws_cloudfront » CfnDistribution » OriginGroupProperty

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 { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const originGroupProperty: cloudfront.CfnDistribution.OriginGroupProperty = {
  failoverCriteria: {
    statusCodes: {
      items: [123],
      quantity: 123,
    },
  },
  id: 'id',
  members: {
    items: [{
      originId: 'originId',
    }],
    quantity: 123,
  },
};

Properties

NameTypeDescription
failoverCriteriaIResolvable | OriginGroupFailoverCriteriaPropertyA complex type that contains information about the failover criteria for an origin group.
idstringThe origin group's ID.
membersIResolvable | OriginGroupMembersPropertyA complex type that contains information about the origins in an origin group.

failoverCriteria

Type: IResolvable | OriginGroupFailoverCriteriaProperty

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


id

Type: string

The origin group's ID.


members

Type: IResolvable | OriginGroupMembersProperty

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