From 9570e99b8ae9263ba19ec82b06d29d3d18b99066 Mon Sep 17 00:00:00 2001 From: "docs-sourcer[bot]" <99042413+docs-sourcer[bot]@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:10:19 -0800 Subject: [PATCH] Updated with the [latest changes](https://github.com/gruntwork-io/terraform-aws-static-assets/releases/tag/v0.19.1) from the `terraform-aws-static-assets@v0.19.1` source branch. (#2279) Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com> --- .../cloudfront/cloudfront.md | 21 +++++------ .../s3-cloudfront/s3-cloudfront.md | 27 +++++++------- .../s3-static-website/s3-static-website.md | 37 +++++++++---------- 3 files changed, 41 insertions(+), 44 deletions(-) diff --git a/docs/reference/modules/terraform-aws-static-assets/cloudfront/cloudfront.md b/docs/reference/modules/terraform-aws-static-assets/cloudfront/cloudfront.md index 440faa27b..2760475f5 100644 --- a/docs/reference/modules/terraform-aws-static-assets/cloudfront/cloudfront.md +++ b/docs/reference/modules/terraform-aws-static-assets/cloudfront/cloudfront.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # CloudFront Module -View Source +View Source Release Notes @@ -21,8 +21,8 @@ This module deploys an [AWS CloudFront](https://aws.amazon.com/cloudfront/) dist ## Quick Start -* See the [cloudfront-custom-origin](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/examples/cloudfront-custom-origin) example for working sample code. -* Check out [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/cloudfront/vars.tf) for all parameters you can set for this module. +* See the [cloudfront-custom-origin](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/examples/cloudfront-custom-origin) example for working sample code. +* Check out [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/cloudfront/vars.tf) for all parameters you can set for this module. ## Sample Usage @@ -37,7 +37,7 @@ This module deploys an [AWS CloudFront](https://aws.amazon.com/cloudfront/) dist module "cloudfront" { - source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/cloudfront?ref=v0.19.0" + source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/cloudfront?ref=v0.19.1" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -303,7 +303,7 @@ module "cloudfront" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/cloudfront?ref=v0.19.0" + source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/cloudfront?ref=v0.19.1" } inputs = { @@ -2573,15 +2573,14 @@ Unique identifier that specifies the AWS WAF web ACL, if any, to associate with - diff --git a/docs/reference/modules/terraform-aws-static-assets/s3-cloudfront/s3-cloudfront.md b/docs/reference/modules/terraform-aws-static-assets/s3-cloudfront/s3-cloudfront.md index f3252931d..3bfee71b6 100644 --- a/docs/reference/modules/terraform-aws-static-assets/s3-cloudfront/s3-cloudfront.md +++ b/docs/reference/modules/terraform-aws-static-assets/s3-cloudfront/s3-cloudfront.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # S3 CloudFront Module -View Source +View Source Release Notes @@ -21,13 +21,13 @@ This module deploys a [CloudFront](https://aws.amazon.com/cloudfront/) distribut (CDN) in front of an [S3 bucket](https://aws.amazon.com/s3/). This reduces latency for your users, by caching your static content in servers around the world. It also allows you to use SSL with the static content in an S3 bucket. -See the [s3-static-website module](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/s3-static-website) for how to deploy static content in an S3 bucket. +See the [s3-static-website module](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/s3-static-website) for how to deploy static content in an S3 bucket. ## Quick Start -* See the [cloudfront-s3-public](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/examples/cloudfront-s3-public) and - [cloudfront-s3-private](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/examples/cloudfront-s3-private) examples for working sample code. -* Check out [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/s3-cloudfront/vars.tf) for all parameters you can set for this module. +* See the [cloudfront-s3-public](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/examples/cloudfront-s3-public) and + [cloudfront-s3-private](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/examples/cloudfront-s3-private) examples for working sample code. +* Check out [vars.tf](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/s3-cloudfront/vars.tf) for all parameters you can set for this module. ## Public vs private S3 buckets @@ -130,7 +130,7 @@ most use cases, but is not particularly flexible. In particular, the limitations * Only one default cache behavior is supported ([cache behaviors](https://www.terraform.io/docs/providers/aws/r/cloudfront_distribution.html#cache-behavior-arguments) is an inline block). You can control the default cache settings using a number of parameters, including - `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.19.0/modules/s3-cloudfront/vars.tf) for the full list). + `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.19.1/modules/s3-cloudfront/vars.tf) for the full list). * Only two error responses are supported ([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. module "s_3_cloudfront" { - source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/s3-cloudfront?ref=v0.19.0" + source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/s3-cloudfront?ref=v0.19.1" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -479,7 +479,7 @@ module "s_3_cloudfront" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/s3-cloudfront?ref=v0.19.0" + source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/s3-cloudfront?ref=v0.19.1" } inputs = { @@ -1514,15 +1514,14 @@ If you have specified whitelist in forward_cook - diff --git a/docs/reference/modules/terraform-aws-static-assets/s3-static-website/s3-static-website.md b/docs/reference/modules/terraform-aws-static-assets/s3-static-website/s3-static-website.md index f9f72860a..7cefb0523 100644 --- a/docs/reference/modules/terraform-aws-static-assets/s3-static-website/s3-static-website.md +++ b/docs/reference/modules/terraform-aws-static-assets/s3-static-website/s3-static-website.md @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # S3 Static Website -View Source +View Source Release Notes @@ -29,7 +29,7 @@ This module creates an AWS S3 bucket that can be used to host a static website. * Optionally configure a custom domain name for the website. -* Optionally deploy a CDN in front of S3 using the [s3-cloudfront module](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/s3-cloudfront). +* Optionally deploy a CDN in front of S3 using the [s3-cloudfront module](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/s3-cloudfront). ## Learn @@ -37,23 +37,23 @@ The reason to serve static content from S3 rather than from your own app server ### Core concepts -* [Quick Start](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/s3-static-website/core-concepts.md#quick-start) +* [Quick Start](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/s3-static-website/core-concepts.md#quick-start) -* [How to test the website](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/s3-static-website/core-concepts.md#how-to-test-the-website) +* [How to test the website](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/s3-static-website/core-concepts.md#how-to-test-the-website) -* [How to configure HTTPS (SSL) or a CDN?](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/s3-static-website/core-concepts.md#how-to-configure-http) +* [How to configure HTTPS (SSL) or a CDN?](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/s3-static-website/core-concepts.md#how-to-configure-http) -* [How to handle www + root domains](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/s3-static-website/core-concepts.md#how-to-handle) +* [How to handle www + root domains](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/s3-static-website/core-concepts.md#how-to-handle) -* [How do I configure Cross Origin Resource Sharing (CORS)?](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules/s3-static-website/core-concepts.md#how-do-i-configure-cross-origin-resource-sharing-cors) +* [How do I configure Cross Origin Resource Sharing (CORS)?](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules/s3-static-website/core-concepts.md#how-do-i-configure-cross-origin-resource-sharing-cors) ### Repo organization -* [modules](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/modules): The main implementation code for this repo, broken down into multiple standalone, orthogonal submodules. +* [modules](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/modules): The main implementation code for this repo, broken down into multiple standalone, orthogonal submodules. -* [examples](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/examples): This folder contains working examples of how to use the submodules. +* [examples](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/examples): This folder contains working examples of how to use the submodules. -* [test](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/test): Automated tests for the modules and examples. +* [test](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/test): Automated tests for the modules and examples. ## Deploy @@ -61,7 +61,7 @@ The reason to serve static content from S3 rather than from your own app server If you just want to try this repo out for experimenting and learning, check out the following resources: -* [Examples folder](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.0/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage). +* [Examples folder](https://github.com/gruntwork-io/terraform-aws-static-assets/tree/v0.19.1/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage). ### Production deployment @@ -82,7 +82,7 @@ If you want to deploy this repo in production, check out the following resources module "s_3_static_website" { - source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/s3-static-website?ref=v0.19.0" + source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/s3-static-website?ref=v0.19.1" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -267,7 +267,7 @@ module "s_3_static_website" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/s3-static-website?ref=v0.19.0" + source = "git::git@github.com:gruntwork-io/terraform-aws-static-assets.git//modules/s3-static-website?ref=v0.19.1" } inputs = { @@ -856,15 +856,14 @@ A value that can be used to chain resources to depend on the website bucket bein -