Skip to content

Commit 0fbb058

Browse files
committed
Updated docs with module refactor
1 parent a6aee17 commit 0fbb058

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,23 +31,26 @@ All contributions are accepted, details on how to contribute can be found in [co
3131
| certificate\_arn | The arn of the certificate to be used for TLS connections. The certificate must be in the same account as the cloudfront resource. | string | n/a | yes |
3232
| cors\_allowed\_headers | Specifies which headers are allowed. | list | n/a | yes |
3333
| cors\_allowed\_origins | A list of allowed CORS origins. | list | n/a | yes |
34+
| namespace | A namespace that is appended to the `site_name` variable. This minimises S3 bucket naming collisions. | string | n/a | yes |
3435
| site\_name | The name of the static website or js bundle to be hosted by the S3 bucket. This will be the bucket name prefix. | string | n/a | yes |
35-
| site\_namespace | A namespace that is appended to the `site_name` variable. This minimises S3 bucket naming collisions. | string | n/a | yes |
3636
| url | The url alias to access the bucket. Must match the certificate name to provide a TLS connection | string | n/a | yes |
3737
| cloudfront\_allowed\_methods | Controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. | list | `<list>` | no |
3838
| cloudfront\_cached\_methods | Controls whether CloudFront caches the response to requests using the specified HTTP methods. | list | `<list>` | no |
39+
| cloudfront\_tags | Additional tags to be added to all cloudfront resources | map | `<map>` | no |
40+
| comment | A comment for the Cloudfront distribution resource | string | `""` | no |
3941
| cors\_allowed\_methods | Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD. Defaults to `GET`, `PUT`, `POST`. | list | `<list>` | no |
4042
| cors\_expose\_headers | Specifies expose header in the response. Defaults to `ETag` | list | `<list>` | no |
4143
| cors\_max\_age\_seconds | Specifies time in seconds that browser can cache the response for a preflight request. Defaults to 1 hour. | string | `"3600"` | no |
4244
| create\_custom\_route53\_record | Determines if a route53 alias record should be created that matches the `url` variable. Default is false. | string | `"false"` | no |
4345
| default\_ttl | The default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request in the absence of an Cache-Control max-age or Expires header. Defaults to 1 hour. | string | `"3600"` | no |
44-
| enable\_bucket\_object\_versioning | Determines if the bucket should version objects. Default is `false`. | string | `"false"` | no |
4546
| enable\_cdn\_compression | Select whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. CloudFront compresses files of certain types for both Amazon S3 and custom origins. Default is `true`. | string | `"true"` | no |
4647
| error\_document\_default | The default error html file. Defaults to `error.html`. | string | `"error.html"` | no |
4748
| index\_document\_default | The default html file. Defaults to `index.html`. | string | `"index.html"` | no |
4849
| max\_ttl | The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. Only effective in the presence of Cache-Control max-age, Cache-Control s-maxage, and Expires headers. Defaults to 7 days. | string | `"604800"` | no |
4950
| min\_ttl | The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. Defaults to 0 seconds. | string | `"0"` | no |
51+
| module\_tags | Additional tags that are added to all resources in this module. | map | `<map>` | no |
5052
| price\_class | The price class for this distribution. One of `PriceClass_All`, `PriceClass_200`, `PriceClass_100` | string | `"PriceClass_All"` | no |
53+
| s3\_tags | Additional tags to be added to all s3 resources | map | `<map>` | no |
5154
| site\_config\_values | A map of js bundle configuration values required for a specific environment. | map | `<map>` | no |
5255
| wait\_for\_deployment | If enabled, the resource will wait for the distribution status to change from `InProgress` to `Deployed`. Setting this to `false` will skip the process. Default: `true`. | string | `"true"` | no |
5356
| zone\_id | The zone id of the hosted zone to create the alias record in. Used only when `create_custom_route53_record` is set to `true`. | string | `""` | no |

0 commit comments

Comments
 (0)