You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-4Lines changed: 1 addition & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -203,7 +203,6 @@ Available targets:
203
203
| <aname="input_allowed_methods"></a> [allowed\_methods](#input\_allowed\_methods)| List of allowed methods (e.g. GET, PUT, POST, DELETE, HEAD) for AWS CloudFront |`list(string)`| <pre>[<br> "DELETE",<br> "GET",<br> "HEAD",<br> "OPTIONS",<br> "PATCH",<br> "POST",<br> "PUT"<br>]</pre> | no |
204
204
| <aname="input_attributes"></a> [attributes](#input\_attributes)| Additional attributes (e.g. `1`) |`list(string)`|`[]`| no |
205
205
| <aname="input_block_origin_public_access_enabled"></a> [block\_origin\_public\_access\_enabled](#input\_block\_origin\_public\_access\_enabled)| When set to 'true' the s3 origin bucket will have public access block enabled |`bool`|`false`| no |
206
-
| <aname="input_bucket_domain_format"></a> [bucket\_domain\_format](#input\_bucket\_domain\_format)| Format of bucket domain name |`string`|`"%s.s3.amazonaws.com"`| no |
207
206
| <aname="input_cached_methods"></a> [cached\_methods](#input\_cached\_methods)| List of cached methods (e.g. GET, PUT, POST, DELETE, HEAD) |`list(string)`| <pre>[<br> "GET",<br> "HEAD"<br>]</pre> | no |
208
207
| <aname="input_cloudfront_origin_access_identity_iam_arn"></a> [cloudfront\_origin\_access\_identity\_iam\_arn](#input\_cloudfront\_origin\_access\_identity\_iam\_arn)| Existing cloudfront origin access identity iam arn that is supplied in the s3 bucket policy |`string`|`""`| no |
209
208
| <aname="input_cloudfront_origin_access_identity_path"></a> [cloudfront\_origin\_access\_identity\_path](#input\_cloudfront\_origin\_access\_identity\_path)| Existing cloudfront origin access identity path used in the cloudfront distribution's s3\_origin\_config content |`string`|`""`| no |
@@ -253,7 +252,7 @@ Available targets:
253
252
| <aname="input_name"></a> [name](#input\_name)| Solution name, e.g. 'app' or 'jenkins' |`string`|`null`| no |
254
253
| <aname="input_namespace"></a> [namespace](#input\_namespace)| Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' |`string`|`null`| no |
255
254
| <a name="input_ordered_cache"></a> [ordered\_cache](#input\_ordered\_cache) | An ordered list of cache behaviors resource for this distribution. List from top to bottom in order of precedence. The topmost cache behavior will have precedence 0.<br>The fields can be described by the other variables in this file. For example, the field 'lambda\_function\_association' in this object has<br>a description in var.lambda\_function\_association variable earlier in this file. The only difference is that fields on this object are in ordered caches, whereas the rest<br>of the vars in this file apply only to the default cache. Put value `""` on field `target_origin_id` to specify default s3 bucket origin. | <pre>list(object({<br> target_origin_id = string<br> path_pattern = string<br><br> allowed_methods = list(string)<br> cached_methods = list(string)<br> compress = bool<br><br> viewer_protocol_policy = string<br> min_ttl = number<br> default_ttl = number<br> max_ttl = number<br><br> forward_query_string = bool<br> forward_header_values = list(string)<br> forward_cookies = string<br><br> lambda_function_association = list(object({<br> event_type = string<br> include_body = bool<br> lambda_arn = string<br> }))<br> }))</pre> | `[]` | no |
256
-
| <aname="input_origin_bucket"></a> [origin\_bucket](#input\_origin\_bucket)| Origin S3 bucket name |`string`|`""`| no |
255
+
| <aname="input_origin_bucket"></a> [origin\_bucket](#input\_origin\_bucket)| Origin S3 bucket name |`string`|`null`| no |
257
256
| <aname="input_origin_force_destroy"></a> [origin\_force\_destroy](#input\_origin\_force\_destroy)| Delete all objects from the bucket so that the bucket can be destroyed without error (e.g. `true` or `false`) |`bool`|`false`| no |
258
257
| <aname="input_origin_path"></a> [origin\_path](#input\_origin\_path)| An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a /. Do not add a / at the end of the path. |`string`|`""`| no |
259
258
| <aname="input_origin_ssl_protocols"></a> [origin\_ssl\_protocols](#input\_origin\_ssl\_protocols)| The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS. |`list(string)`| <pre>[<br> "TLSv1",<br> "TLSv1.1",<br> "TLSv1.2"<br>]</pre> | no |
@@ -265,10 +264,8 @@ Available targets:
265
264
| <aname="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars)| Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |`string`|`null`| no |
266
265
| <aname="input_routing_rules"></a> [routing\_rules](#input\_routing\_rules)| A json array containing routing rules describing redirect behavior and when redirects are applied |`string`|`""`| no |
267
266
| <aname="input_stage"></a> [stage](#input\_stage)| Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
268
-
| <aname="input_static_s3_bucket"></a> [static\_s3\_bucket](#input\_static\_s3\_bucket)| aws-cli is a bucket owned by amazon that will perminantly exist.<br>It allows for the data source to be called during the destruction process without failing.<br>It doesn't get used for anything else, this is a safe workaround for handling the fact that<br>if a data source like the one `aws_s3_bucket.selected` gets an error, you can't continue the terraform process<br>which also includes the 'destroy' command, where is doesn't even need this data source!<br>Don't change this bucket name, it's a variable so that we can provide this description.<br>And this works around a problem that is an edge case. |`string`|`"aws-cli"`| no |
269
267
| <aname="input_tags"></a> [tags](#input\_tags)| Additional tags (e.g. `map('BusinessUnit','XYZ')`|`map(string)`|`{}`| no |
270
268
| <aname="input_trusted_signers"></a> [trusted\_signers](#input\_trusted\_signers)| The AWS accounts, if any, that you want to allow to create signed URLs for private content. 'self' is acceptable. |`list(string)`|`[]`| no |
271
-
| <aname="input_use_regional_s3_endpoint"></a> [use\_regional\_s3\_endpoint](#input\_use\_regional\_s3\_endpoint)| When set to 'true' the s3 origin\_bucket will use the regional endpoint address instead of the global endpoint address |`bool`|`false`| no |
272
269
| <aname="input_versioning_enabled"></a> [versioning\_enabled](#input\_versioning\_enabled)| When set to 'true' the s3 origin bucket will have versioning enabled |`bool`|`true`| no |
273
270
| <aname="input_viewer_protocol_policy"></a> [viewer\_protocol\_policy](#input\_viewer\_protocol\_policy)| allow-all, redirect-to-https |`string`|`"redirect-to-https"`| no |
274
271
| <aname="input_wait_for_deployment"></a> [wait\_for\_deployment](#input\_wait\_for\_deployment)| When set to 'true' the resource will wait for the distribution status to change from InProgress to Deployed |`bool`|`true`| no |
Copy file name to clipboardExpand all lines: docs/terraform.md
+1-4Lines changed: 1 addition & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,6 @@
46
46
| <aname="input_allowed_methods"></a> [allowed\_methods](#input\_allowed\_methods)| List of allowed methods (e.g. GET, PUT, POST, DELETE, HEAD) for AWS CloudFront |`list(string)`| <pre>[<br> "DELETE",<br> "GET",<br> "HEAD",<br> "OPTIONS",<br> "PATCH",<br> "POST",<br> "PUT"<br>]</pre> | no |
47
47
| <aname="input_attributes"></a> [attributes](#input\_attributes)| Additional attributes (e.g. `1`) |`list(string)`|`[]`| no |
48
48
| <aname="input_block_origin_public_access_enabled"></a> [block\_origin\_public\_access\_enabled](#input\_block\_origin\_public\_access\_enabled)| When set to 'true' the s3 origin bucket will have public access block enabled |`bool`|`false`| no |
49
-
| <aname="input_bucket_domain_format"></a> [bucket\_domain\_format](#input\_bucket\_domain\_format)| Format of bucket domain name |`string`|`"%s.s3.amazonaws.com"`| no |
50
49
| <aname="input_cached_methods"></a> [cached\_methods](#input\_cached\_methods)| List of cached methods (e.g. GET, PUT, POST, DELETE, HEAD) |`list(string)`| <pre>[<br> "GET",<br> "HEAD"<br>]</pre> | no |
51
50
| <aname="input_cloudfront_origin_access_identity_iam_arn"></a> [cloudfront\_origin\_access\_identity\_iam\_arn](#input\_cloudfront\_origin\_access\_identity\_iam\_arn)| Existing cloudfront origin access identity iam arn that is supplied in the s3 bucket policy |`string`|`""`| no |
52
51
| <aname="input_cloudfront_origin_access_identity_path"></a> [cloudfront\_origin\_access\_identity\_path](#input\_cloudfront\_origin\_access\_identity\_path)| Existing cloudfront origin access identity path used in the cloudfront distribution's s3\_origin\_config content |`string`|`""`| no |
@@ -96,7 +95,7 @@
96
95
| <aname="input_name"></a> [name](#input\_name)| Solution name, e.g. 'app' or 'jenkins' |`string`|`null`| no |
97
96
| <aname="input_namespace"></a> [namespace](#input\_namespace)| Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' |`string`|`null`| no |
98
97
| <a name="input_ordered_cache"></a> [ordered\_cache](#input\_ordered\_cache) | An ordered list of cache behaviors resource for this distribution. List from top to bottom in order of precedence. The topmost cache behavior will have precedence 0.<br>The fields can be described by the other variables in this file. For example, the field 'lambda\_function\_association' in this object has<br>a description in var.lambda\_function\_association variable earlier in this file. The only difference is that fields on this object are in ordered caches, whereas the rest<br>of the vars in this file apply only to the default cache. Put value `""` on field `target_origin_id` to specify default s3 bucket origin. | <pre>list(object({<br> target_origin_id = string<br> path_pattern = string<br><br> allowed_methods = list(string)<br> cached_methods = list(string)<br> compress = bool<br><br> viewer_protocol_policy = string<br> min_ttl = number<br> default_ttl = number<br> max_ttl = number<br><br> forward_query_string = bool<br> forward_header_values = list(string)<br> forward_cookies = string<br><br> lambda_function_association = list(object({<br> event_type = string<br> include_body = bool<br> lambda_arn = string<br> }))<br> }))</pre> | `[]` | no |
99
-
| <aname="input_origin_bucket"></a> [origin\_bucket](#input\_origin\_bucket)| Origin S3 bucket name |`string`|`""`| no |
98
+
| <aname="input_origin_bucket"></a> [origin\_bucket](#input\_origin\_bucket)| Origin S3 bucket name |`string`|`null`| no |
100
99
| <aname="input_origin_force_destroy"></a> [origin\_force\_destroy](#input\_origin\_force\_destroy)| Delete all objects from the bucket so that the bucket can be destroyed without error (e.g. `true` or `false`) |`bool`|`false`| no |
101
100
| <aname="input_origin_path"></a> [origin\_path](#input\_origin\_path)| An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a /. Do not add a / at the end of the path. |`string`|`""`| no |
102
101
| <aname="input_origin_ssl_protocols"></a> [origin\_ssl\_protocols](#input\_origin\_ssl\_protocols)| The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS. |`list(string)`| <pre>[<br> "TLSv1",<br> "TLSv1.1",<br> "TLSv1.2"<br>]</pre> | no |
@@ -108,10 +107,8 @@
108
107
| <aname="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars)| Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |`string`|`null`| no |
109
108
| <aname="input_routing_rules"></a> [routing\_rules](#input\_routing\_rules)| A json array containing routing rules describing redirect behavior and when redirects are applied |`string`|`""`| no |
110
109
| <aname="input_stage"></a> [stage](#input\_stage)| Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
111
-
| <aname="input_static_s3_bucket"></a> [static\_s3\_bucket](#input\_static\_s3\_bucket)| aws-cli is a bucket owned by amazon that will perminantly exist.<br>It allows for the data source to be called during the destruction process without failing.<br>It doesn't get used for anything else, this is a safe workaround for handling the fact that<br>if a data source like the one `aws_s3_bucket.selected` gets an error, you can't continue the terraform process<br>which also includes the 'destroy' command, where is doesn't even need this data source!<br>Don't change this bucket name, it's a variable so that we can provide this description.<br>And this works around a problem that is an edge case. |`string`|`"aws-cli"`| no |
112
110
| <aname="input_tags"></a> [tags](#input\_tags)| Additional tags (e.g. `map('BusinessUnit','XYZ')`|`map(string)`|`{}`| no |
113
111
| <aname="input_trusted_signers"></a> [trusted\_signers](#input\_trusted\_signers)| The AWS accounts, if any, that you want to allow to create signed URLs for private content. 'self' is acceptable. |`list(string)`|`[]`| no |
114
-
| <aname="input_use_regional_s3_endpoint"></a> [use\_regional\_s3\_endpoint](#input\_use\_regional\_s3\_endpoint)| When set to 'true' the s3 origin\_bucket will use the regional endpoint address instead of the global endpoint address |`bool`|`false`| no |
115
112
| <aname="input_versioning_enabled"></a> [versioning\_enabled](#input\_versioning\_enabled)| When set to 'true' the s3 origin bucket will have versioning enabled |`bool`|`true`| no |
116
113
| <aname="input_viewer_protocol_policy"></a> [viewer\_protocol\_policy](#input\_viewer\_protocol\_policy)| allow-all, redirect-to-https |`string`|`"redirect-to-https"`| no |
117
114
| <aname="input_wait_for_deployment"></a> [wait\_for\_deployment](#input\_wait\_for\_deployment)| When set to 'true' the resource will wait for the distribution status to change from InProgress to Deployed |`bool`|`true`| no |
0 commit comments