Skip to content

Commit 05a83f0

Browse files
Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
1 parent 42f998c commit 05a83f0

File tree

3 files changed

+76
-102
lines changed

3 files changed

+76
-102
lines changed

docs/reference/modules/terraform-aws-static-assets/cloudfront/cloudfront.md

Lines changed: 45 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Static Assets Modules" version="0.20.3" lastModifiedVersion="0.20.3"/>
12+
<VersionBadge repoTitle="Static Assets Modules" version="0.20.4" lastModifiedVersion="0.20.4"/>
1313

1414
# CloudFront Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/cloudfront" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/cloudfront" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

18-
<a href="https://github.com/gruntwork-io/terraform-aws-static-assets/releases/tag/v0.20.3" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
18+
<a href="https://github.com/gruntwork-io/terraform-aws-static-assets/releases/tag/v0.20.4" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This module deploys an [AWS CloudFront](https://aws.amazon.com/cloudfront/) distribution to serve content from S3 or custom origins. CloudFront is a Content Delivery Network (CDN) that caches your content at edge locations around the world to reduce latency and improve performance for your users.
2121

2222
## Quick Start
2323

24-
* See the [cloudfront-custom-origin](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/examples/cloudfront) example for working sample code.
25-
* Check out [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/cloudfront/vars.tf) for all parameters you can set for this module.
24+
* See the [cloudfront-custom-origin](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/examples/cloudfront) example for working sample code.
25+
* Check out [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/cloudfront/vars.tf) for all parameters you can set for this module.
2626

2727
## Sample Usage
2828

@@ -37,7 +37,7 @@ This module deploys an [AWS CloudFront](https://aws.amazon.com/cloudfront/) dist
3737
3838
module "cloudfront" {
3939
40-
source = "git::[email protected]:gruntwork-io/terraform-aws-static-assets.git//modules/cloudfront?ref=v0.20.3"
40+
source = "git::[email protected]:gruntwork-io/terraform-aws-static-assets.git//modules/cloudfront?ref=v0.20.4"
4141
4242
# ----------------------------------------------------------------------------------------------------
4343
# REQUIRED VARIABLES
@@ -228,10 +228,10 @@ module "cloudfront" {
228228
# Any comments you want to include about the distribution.
229229
comment = null
230230
231-
# continuous deployment policy. This argument should only be set on a
232-
# production distribution. See the aws_cloudfront_continuous_deployment_policy
233-
# resource for additional details.
234-
continuous_deployment_policy = {"is_continuous_deployment_policy_enabled":false}
231+
# continuous deployment policy. This argument should only be set on a STAGING
232+
# distribution. See the aws_cloudfront_continuous_deployment_policy resource
233+
# for additional details.
234+
continuous_deployment_policy = null
235235
236236
# One or more custom error response elements.
237237
custom_error_response = []
@@ -247,6 +247,12 @@ module "cloudfront" {
247247
# Whether the distribution is enabled to accept end user requests for content.
248248
enabled = true
249249
250+
# The ID of the continuous deployment policy to associate with the
251+
# distribution. This argument should only be set on a production distribution.
252+
# See the aws_cloudfront_continuous_deployment_policy resource for additional
253+
# details.
254+
existing_continuous_deployment_policy_id = null
255+
250256
# The restriction configuration for this distribution (geo_restrictions)
251257
geo_restriction = [{"locations":[],"restriction_type":"none"}]
252258
@@ -319,7 +325,7 @@ module "cloudfront" {
319325
# ------------------------------------------------------------------------------------------------------
320326
321327
terraform {
322-
source = "git::[email protected]:gruntwork-io/terraform-aws-static-assets.git//modules/cloudfront?ref=v0.20.3"
328+
source = "git::[email protected]:gruntwork-io/terraform-aws-static-assets.git//modules/cloudfront?ref=v0.20.4"
323329
}
324330
325331
inputs = {
@@ -513,10 +519,10 @@ inputs = {
513519
# Any comments you want to include about the distribution.
514520
comment = null
515521
516-
# continuous deployment policy. This argument should only be set on a
517-
# production distribution. See the aws_cloudfront_continuous_deployment_policy
518-
# resource for additional details.
519-
continuous_deployment_policy = {"is_continuous_deployment_policy_enabled":false}
522+
# continuous deployment policy. This argument should only be set on a STAGING
523+
# distribution. See the aws_cloudfront_continuous_deployment_policy resource
524+
# for additional details.
525+
continuous_deployment_policy = null
520526
521527
# One or more custom error response elements.
522528
custom_error_response = []
@@ -532,6 +538,12 @@ inputs = {
532538
# Whether the distribution is enabled to accept end user requests for content.
533539
enabled = true
534540
541+
# The ID of the continuous deployment policy to associate with the
542+
# distribution. This argument should only be set on a production distribution.
543+
# See the aws_cloudfront_continuous_deployment_policy resource for additional
544+
# details.
545+
existing_continuous_deployment_policy_id = null
546+
535547
# The restriction configuration for this distribution (geo_restrictions)
536548
geo_restriction = [{"locations":[],"restriction_type":"none"}]
537549
@@ -1941,25 +1953,13 @@ Any comments you want to include about the distribution.
19411953
<HclListItem name="continuous_deployment_policy" requirement="optional" type="object(…)">
19421954
<HclListItemDescription>
19431955

1944-
continuous deployment policy. This argument should only be set on a production distribution. See the aws_cloudfront_continuous_deployment_policy resource for additional details.
1956+
continuous deployment policy. This argument should only be set on a STAGING distribution. See the aws_cloudfront_continuous_deployment_policy resource for additional details.
19451957

19461958
</HclListItemDescription>
19471959
<HclListItemTypeDetails>
19481960

19491961
```hcl
19501962
object({
1951-
# Flag to enable continuous deployment policy.
1952-
is_continuous_deployment_policy_enabled = bool
1953-
1954-
# CloudFront domain name of the staging distribution.
1955-
staging_distribution_dns_names = optional(object({
1956-
# A list of CloudFront domain names for the staging distribution.
1957-
items = list(string)
1958-
1959-
# Number of CloudFront domain names in the staging distribution.
1960-
quantity = number
1961-
}))
1962-
19631963
# Parameters for routing production traffic from primary to staging distributions.
19641964
traffic_config = optional(object({
19651965
# Type of traffic configuration. Valid values are SingleWeight and SingleHeader.
@@ -1997,49 +1997,11 @@ object({
19971997
```
19981998

19991999
</HclListItemTypeDetails>
2000-
<HclListItemDefaultValue>
2001-
2002-
```hcl
2003-
{
2004-
is_continuous_deployment_policy_enabled = false
2005-
}
2006-
```
2007-
2008-
</HclListItemDefaultValue>
2000+
<HclListItemDefaultValue defaultValue="null"/>
20092001
<HclGeneralListItem title="More Details">
20102002
<details>
20112003

20122004

2013-
```hcl
2014-
2015-
CloudFront domain name of the staging distribution.
2016-
2017-
```
2018-
</details>
2019-
2020-
<details>
2021-
2022-
2023-
```hcl
2024-
2025-
Number of CloudFront domain names in the staging distribution.
2026-
2027-
```
2028-
</details>
2029-
2030-
<details>
2031-
2032-
2033-
```hcl
2034-
2035-
Parameters for routing production traffic from primary to staging distributions.
2036-
2037-
```
2038-
</details>
2039-
2040-
<details>
2041-
2042-
20432005
```hcl
20442006
20452007
Determines which HTTP requests are sent to the staging distribution.
@@ -2195,6 +2157,15 @@ Whether the distribution is enabled to accept end user requests for content.
21952157
<HclListItemDefaultValue defaultValue="true"/>
21962158
</HclListItem>
21972159

2160+
<HclListItem name="existing_continuous_deployment_policy_id" requirement="optional" type="string">
2161+
<HclListItemDescription>
2162+
2163+
The ID of the continuous deployment policy to associate with the distribution. This argument should only be set on a production distribution. See the aws_cloudfront_continuous_deployment_policy resource for additional details.
2164+
2165+
</HclListItemDescription>
2166+
<HclListItemDefaultValue defaultValue="null"/>
2167+
</HclListItem>
2168+
21982169
<HclListItem name="geo_restriction" requirement="optional" type="list(object(…))">
21992170
<HclListItemDescription>
22002171

@@ -2876,17 +2847,20 @@ Unique identifier that specifies the AWS WAF web ACL, if any, to associate with
28762847
<HclListItem name="cloudfront_distribution">
28772848
</HclListItem>
28782849

2850+
<HclListItem name="cloudfront_distribution_continuous_deployment_policy">
2851+
</HclListItem>
2852+
28792853
</TabItem>
28802854
</Tabs>
28812855

28822856
<!-- ##DOCS-SOURCER-START
28832857
{
28842858
"originalSources": [
2885-
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/cloudfront/readme.md",
2886-
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/cloudfront/variables.tf",
2887-
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/cloudfront/outputs.tf"
2859+
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/cloudfront/readme.md",
2860+
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/cloudfront/variables.tf",
2861+
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/cloudfront/outputs.tf"
28882862
],
28892863
"sourcePlugin": "module-catalog-api",
2890-
"hash": "6a64ca6a4e980acfe29f5c81e7ed0230"
2864+
"hash": "7f710fcfa4d0c857889993cc5dc91ad4"
28912865
}
28922866
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-static-assets/s3-cloudfront/s3-cloudfront.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,25 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Static Assets Modules" version="0.20.3" lastModifiedVersion="0.18.5"/>
12+
<VersionBadge repoTitle="Static Assets Modules" version="0.20.4" lastModifiedVersion="0.18.5"/>
1313

1414
# S3 CloudFront Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/s3-cloudfront" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/s3-cloudfront" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-static-assets/releases/tag/v0.18.5" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This module deploys a [CloudFront](https://aws.amazon.com/cloudfront/) distribution as a Content Distribution Network
2121
(CDN) in front of an [S3 bucket](https://aws.amazon.com/s3/). This reduces latency for your users, by caching your
2222
static content in servers around the world. It also allows you to use SSL with the static content in an S3 bucket.
2323

24-
See the [s3-static-website module](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/s3-static-website) for how to deploy static content in an S3 bucket.
24+
See the [s3-static-website module](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/s3-static-website) for how to deploy static content in an S3 bucket.
2525

2626
## Quick Start
2727

28-
* See the [cloudfront-s3-public](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/examples/cloudfront-s3-public) and
29-
[cloudfront-s3-private](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/examples/cloudfront-s3-private) examples for working sample code.
30-
* Check out [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/s3-cloudfront/vars.tf) for all parameters you can set for this module.
28+
* See the [cloudfront-s3-public](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/examples/cloudfront-s3-public) and
29+
[cloudfront-s3-private](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/examples/cloudfront-s3-private) examples for working sample code.
30+
* Check out [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/s3-cloudfront/vars.tf) for all parameters you can set for this module.
3131

3232
## Public vs private S3 buckets
3333

@@ -130,7 +130,7 @@ most use cases, but is not particularly flexible. In particular, the limitations
130130
* Only one default cache behavior is supported
131131
([cache behaviors](https://www.terraform.io/docs/providers/aws/r/cloudfront_distribution.html#cache-behavior-arguments)
132132
is an inline block). You can control the default cache settings using a number of parameters, including
133-
`cached_methods`, `default_ttl`, `min_ttl`, `max_ttl`, and many others (see [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/s3-cloudfront/vars.tf) for the full list).
133+
`cached_methods`, `default_ttl`, `min_ttl`, `max_ttl`, and many others (see [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/s3-cloudfront/vars.tf) for the full list).
134134

135135
* Only two error responses are supported
136136
([error responses](https://www.terraform.io/docs/providers/aws/r/cloudfront_distribution.html#custom-error-response-arguments)
@@ -162,7 +162,7 @@ into your own codebase, using it as a guide, and adding the tweaks you need.
162162
163163
module "s_3_cloudfront" {
164164
165-
source = "git::[email protected]:gruntwork-io/terraform-aws-static-assets.git//modules/s3-cloudfront?ref=v0.20.3"
165+
source = "git::[email protected]:gruntwork-io/terraform-aws-static-assets.git//modules/s3-cloudfront?ref=v0.20.4"
166166
167167
# ----------------------------------------------------------------------------------------------------
168168
# REQUIRED VARIABLES
@@ -479,7 +479,7 @@ module "s_3_cloudfront" {
479479
# ------------------------------------------------------------------------------------------------------
480480
481481
terraform {
482-
source = "git::[email protected]:gruntwork-io/terraform-aws-static-assets.git//modules/s3-cloudfront?ref=v0.20.3"
482+
source = "git::[email protected]:gruntwork-io/terraform-aws-static-assets.git//modules/s3-cloudfront?ref=v0.20.4"
483483
}
484484
485485
inputs = {
@@ -1517,11 +1517,11 @@ If you have specified whitelist in <a href="#forward_cookies"><code>forward_cook
15171517
<!-- ##DOCS-SOURCER-START
15181518
{
15191519
"originalSources": [
1520-
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/s3-cloudfront/readme.md",
1521-
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/s3-cloudfront/variables.tf",
1522-
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.3/modules/s3-cloudfront/outputs.tf"
1520+
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/s3-cloudfront/readme.md",
1521+
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/s3-cloudfront/variables.tf",
1522+
"https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.20.4/modules/s3-cloudfront/outputs.tf"
15231523
],
15241524
"sourcePlugin": "module-catalog-api",
1525-
"hash": "407949008087dc20ae59dc8dd378fd0e"
1525+
"hash": "f93e952c4a1b370533344705c7472eca"
15261526
}
15271527
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)