Skip navigation links

Package software.amazon.awscdk.services.cloudfront.origins

CloudFront Origins for the CDK CloudFront Library

See: Description

Package software.amazon.awscdk.services.cloudfront.origins Description

CloudFront Origins for the CDK CloudFront Library

---

cdk-constructs: Stable


This library contains convenience methods for defining origins for a CloudFront distribution. You can use this library to create origins from S3 buckets, Elastic Load Balancing v2 load balancers, or any other domain name.

S3 Bucket

An S3 bucket can be added as an origin. If the bucket is configured as a website endpoint, the distribution can use S3 redirects and S3 custom error documents.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.cloudfront.*;
 import software.amazon.awscdk.services.cloudfront.origins.*;
 
 Object myBucket = new Bucket(this, "myBucket");
 new Distribution(this, "myDist", new DistributionProps()
         .defaultBehavior(new BehaviorOptions().origin(new S3Origin(myBucket))));
 

The above will treat the bucket differently based on if IBucket.isWebsite is set or not. If the bucket is configured as a website, the bucket is treated as an HTTP origin, and the built-in S3 redirects and error pages can be used. Otherwise, the bucket is handled as a bucket origin and CloudFront's redirect and error handling will be used. In the latter case, the Origin will create an origin access identity and grant it access to the underlying bucket. This can be used in conjunction with a bucket that is not public to require that your users access your content using CloudFront URLs and not S3 URLs directly. Alternatively, a custom origin access identity can be passed to the S3 origin in the properties.

Adding Custom Headers

You can configure CloudFront to add custom headers to the requests that it sends to your origin. These custom headers enable you to send and gather information from your origin that you don’t get with typical viewer requests. These headers can even be customized for each origin. CloudFront supports custom headers for both for custom and Amazon S3 origins.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.cloudfront.*;
 import software.amazon.awscdk.services.cloudfront.origins.*;
 
 Object myBucket = new Bucket(this, "myBucket");
 new Distribution(this, "myDist", new DistributionProps()
         .defaultBehavior(new BehaviorOptions().origin(new S3Origin(myBucket, new S3OriginProps()
                 .customHeaders(Map.of(
                         "Foo", "bar"))))));
 

ELBv2 Load Balancer

An Elastic Load Balancing (ELB) v2 load balancer may be used as an origin. In order for a load balancer to serve as an origin, it must be publicly accessible (internetFacing is true). Both Application and Network load balancers are supported.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 
 Vpc vpc = new Vpc(...);
 // Create an application load balancer in a VPC. 'internetFacing' must be 'true'
 // for CloudFront to access the load balancer and use it as an origin.
 ApplicationLoadBalancer lb = new ApplicationLoadBalancer(this, "LB", new ApplicationLoadBalancerProps()
         .vpc(vpc)
         .internetFacing(true));
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(Map.of("origin", new LoadBalancerV2Origin(lb)))
         .build();
 

The origin can also be customized to respond on different ports, have different connection properties, etc.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 Object origin = LoadBalancerV2Origin.Builder.create(loadBalancer)
         .connectionAttempts(3)
         .connectionTimeout(Duration.seconds(5))
         .protocolPolicy(cloudfront.OriginProtocolPolicy.getMATCH_VIEWER())
         .build();
 

From an HTTP endpoint

Origins can also be created from any other HTTP endpoint, given the domain name, and optionally, other origin properties.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(Map.of("origin", new HttpOrigin("www.example.com")))
         .build();
 

See the documentation of @aws-cdk/aws-cloudfront for more information.

Failover Origins (Origin Groups)

You can set up CloudFront with origin failover for scenarios that require high availability. To get started, you create an origin group with two origins: a primary and a secondary. If the primary origin is unavailable, or returns specific HTTP response status codes that indicate a failure, CloudFront automatically switches to the secondary origin. You achieve that behavior in the CDK using the OriginGroup class:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(Map.of(
                 "origin", OriginGroup.Builder.create()
                         .primaryOrigin(new S3Origin(myBucket))
                         .fallbackOrigin(new HttpOrigin("www.example.com"))
                         // optional, defaults to: 500, 502, 503 and 504
                         .fallbackStatusCodes(List.of(404))
                         .build()))
         .build();
 
Skip navigation links