OriginGroup

class aws_cdk.aws_cloudfront_origins.OriginGroup(*, fallback_origin, primary_origin, fallback_status_codes=None)

Bases: object

An Origin that represents a group.

Consists of a primary Origin, and a fallback Origin called when the primary returns one of the provided HTTP status codes.

ExampleMetadata:: infused

Example:

my_bucket = s3.Bucket(self, "myBucket")
cloudfront.Distribution(self, "myDist",
    default_behavior=cloudfront.BehaviorOptions(
        origin=origins.OriginGroup(
            primary_origin=origins.S3BucketOrigin.with_origin_access_control(my_bucket),
            fallback_origin=origins.HttpOrigin("www.example.com"),
            # optional, defaults to: 500, 502, 503 and 504
            fallback_status_codes=[404]
        )
    )
)

Parameters:

fallback_origin (IOrigin) – The fallback origin that should serve requests when the primary fails.
primary_origin (IOrigin) – The primary origin that should serve requests for this group.
fallback_status_codes (Optional[Sequence[Union[int, float]]]) – The list of HTTP status codes that, when returned from the primary origin, would cause querying the fallback origin. Default: - 500, 502, 503 and 504

Methods

bind(scope, *, origin_id, distribution_id=None)

The method called when a given Origin is added (for the first time) to a Distribution.

Parameters:

scope (Construct) –
origin_id (str) – The identifier of this Origin, as assigned by the Distribution this Origin has been used added to.
distribution_id (Optional[str]) – The identifier of the Distribution this Origin is used for. This is used to grant origin access permissions to the distribution for origin access control. Default: - no distribution id

Return type:

OriginBindConfig