Skip to content

Commit

Permalink
chore(cloudfront): README updates and notes of breaking changes (#9356)
Browse files Browse the repository at this point in the history
Making a small -- but useful -- README change as an excuse to capture the
breaking changes made in #9326, but that were missed in that commit message.

BREAKING CHANGE: Removed origin classes from the aws-cloudfront module.
* **aws-cloudfront:** Removed S3Origin and HttpOrigin from the aws-cloudfront module. Use the S3Origin and HttpOrigin classes in the aws-cloudfront-origins module instead.
* **aws-cloudfront:** Renamed Origin to OriginBase.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
njlynch authored Jul 30, 2020
1 parent 3cf6a94 commit fbb0418
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/@aws-cdk/aws-cloudfront/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ for more complex use cases.

CloudFront distributions deliver your content from one or more origins; an origin is the location where you store the original version of your
content. Origins can be created from S3 buckets or a custom origin (HTTP server). Each distribution has a default behavior which applies to all
requests to that distribution, and routes requests to a primary origin.
requests to that distribution, and routes requests to a primary origin. Constructs to define origins are in the `@aws-cdk/aws-cloudfront-origins`
module.

#### From an S3 Bucket

Expand Down Expand Up @@ -323,7 +324,6 @@ const distribution = new CloudFrontWebDistribution(this, 'MyDistribution', {
In case the origin source is not available and answers with one of the
specified status code the failover origin source will be used.


```ts
new CloudFrontWebDistribution(stack, 'ADistribution', {
originConfigs: [
Expand Down

0 comments on commit fbb0418

Please sign in to comment.