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
+34-28Lines changed: 34 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,44 +27,50 @@ This repo supports version 0.11 and 0.12 of Terraform. The implementation patter
27
27
## Contributions
28
28
All contributions are accepted, details on how to contribute can be found in [contrib.md](contrib.md).
29
29
30
+
## Providers
31
+
32
+
| Name | Version |
33
+
|------|---------|
34
+
| aws |~> 2.19 |
35
+
30
36
## Inputs
31
37
32
38
| Name | Description | Type | Default | Required |
33
-
|------|-------------|:----:|:-----:|:-----:|
34
-
| 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 |
35
-
| cors\_allowed\_headers | Specifies which headers are allowed. | list | n/a | yes |
36
-
| cors\_allowed\_origins | A list of allowed CORS origins. | list | n/a | yes |
37
-
| namespace | A namespace that is appended to the `site_name` variable. This minimises S3 bucket naming collisions. |string| n/a | yes |
38
-
| 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 |
39
-
| url | The url alias to access the bucket. Must match the certificate name to provide a TLS connection |string| n/a | yes |
40
-
| cloudfront\_allowed\_methods | Controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. | list |`<list>`| no |
41
-
| cloudfront\_cached\_methods | Controls whether CloudFront caches the response to requests using the specified HTTP methods. | list |`<list>`| no |
42
-
| cloudfront\_tags | Additional tags to be added to all cloudfront resources | map |`<map>`| no |
43
-
| comment | A comment for the Cloudfront distribution resource | string |`""`| no |
44
-
| cors\_allowed\_methods | Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD. Defaults to `GET`, `PUT`, `POST`. | list |`<list>`| no |
45
-
| cors\_expose\_headers | Specifies expose header in the response. Defaults to `ETag`| list |`<list>`| no |
46
-
| 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 |
47
-
| create\_custom\_route53\_record | Determines if a route53 alias record should be created that matches the `url` variable. Default is false. |string|`"false"`| no |
48
-
| 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 |
49
-
| 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 |
50
-
| error\_document\_default | The default error html file. Defaults to `error.html`. | string |`"error.html"`| no |
51
-
| index\_document\_default | The default html file. Defaults to `index.html`. | string |`"index.html"`| no |
52
-
| 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 |
53
-
| 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 |
54
-
| module\_tags | Additional tags that are added to all resources in this module. | map |`<map>`| no |
55
-
| price\_class | The price class for this distribution. One of `PriceClass_All`, `PriceClass_200`, `PriceClass_100`| string |`"PriceClass_All"`| no |
56
-
| s3\_tags | Additional tags to be added to all s3 resources | map |`<map>`| no |
57
-
| site\_config\_values | A map of js bundle configuration values required for a specific environment. | map |`<map>`| no |
58
-
| 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 |
59
-
| 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 |
39
+
|------|-------------|------|---------|:-----:|
40
+
| 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. |`any`| n/a | yes |
41
+
| cors\_allowed\_headers | Specifies which headers are allowed. |`list(string)`| n/a | yes |
42
+
| cors\_allowed\_origins | A list of allowed CORS origins. |`list(string)`| n/a | yes |
43
+
| namespace | A namespace that is appended to the `site_name` variable. This minimises S3 bucket naming collisions. |`any`| n/a | yes |
44
+
| 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. |`any`| n/a | yes |
45
+
| url | The custom URL to access the site. Must match the certificate name to provide a valid TLS connection.|`any`| n/a | yes |
46
+
| cloudfront\_allowed\_methods | Controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. |`list(string)`|<pre>[<br> "GET",<br> "HEAD",<br> "OPTIONS"<br>]<br></pre>| no |
47
+
| cloudfront\_cached\_methods | Controls whether CloudFront caches the response to requests using the specified HTTP methods. |`list(string)`|<pre>[<br> "GET",<br> "HEAD"<br>]<br></pre>| no |
48
+
| cloudfront\_tags | Additional tags to be added to all cloudfront resources.|`map(any)`|`{}`| no |
49
+
| comment | A comment for the Cloudfront distribution resource |`string`|`""`| no |
50
+
| cors\_allowed\_methods | Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD. Defaults to `GET`, `PUT`, `POST`. |`list(string)`|<pre>[<br> "GET",<br> "PUT",<br> "POST"<br>]<br></pre>| no |
51
+
| cors\_expose\_headers | Specifies expose header in the response. Defaults to `ETag`.|`list(string)`|<pre>[<br> "ETag"<br>]<br></pre>| no |
52
+
| cors\_max\_age\_seconds | Specifies time in seconds that browser can cache the response for a preflight request. Defaults to 1 hour. |`number`|`3600`| no |
53
+
| create\_custom\_route53\_record | Determines if a route53 alias record should be created that matches the `url` variable. Default is false. |`bool`|`false`| no |
54
+
| 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. |`number`|`3600`| no |
55
+
| 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`. |`bool`|`true`| no |
56
+
| error\_document\_default | The default error html file. Defaults to `error.html`. |`string`|`"error.html"`| no |
57
+
| index\_document\_default | The default html file. Defaults to `index.html`. |`string`|`"index.html"`| no |
58
+
| 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. |`number`|`604800`| no |
59
+
| 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. |`number`|`0`| no |
60
+
| module\_tags | Additional tags that are added to all resources in this module. |`map(any)`|`{}`| no |
61
+
| price\_class | The price class for this distribution. One of `PriceClass_All`, `PriceClass_200`, `PriceClass_100`.|`string`|`"PriceClass_All"`| no |
62
+
| s3\_tags | Additional tags to be added to all s3 resources.|`map(any)`|`{}`| no |
63
+
| site\_config\_values | A map of js bundle configuration values required for a specific environment. |`map(any)`|`{}`| no |
64
+
| 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`. |`bool`|`true`| no |
65
+
| 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 |
60
66
61
67
## Outputs
62
68
63
69
| Name | Description |
64
70
|------|-------------|
65
71
| cloudfront\_hosted\_zone | The hosted zone id of the Cloudfront Distribution |
66
72
| cloudfront\_url | The URL for the Cloudfront Distribution - used to set the alias for the custom domain. |
67
-
| s3\_bucket\_hosted\_id | The hosted_id s3 web site bucket. |
73
+
| s3\_bucket\_hosted\_id | The hosted\_id s3 web site bucket. |
68
74
| s3\_bucket\_website\_domain | The domain of the s3 web site bucket. |
69
75
| s3\_bucket\_website\_endpoint | The endpoint of the s3 web site bucket. |
Copy file name to clipboardExpand all lines: artifactory/README.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,20 @@ This Terraform module is provided as an additional component for those wanting t
4
4
5
5
This has been provided as an additional module to meet the architectural needs of a global module i.e. there will only ever be one module implementation of an artifactory, as opposed to n number of s3-static-website module implementations, where n is the number of environments. This module design also caters for cross AWS Account patterns.
6
6
7
+
## Providers
8
+
9
+
| Name | Version |
10
+
|------|---------|
11
+
| aws |~> 2.19 |
12
+
7
13
## Inputs
8
14
9
15
| Name | Description | Type | Default | Required |
10
-
|------|-------------|:----:|:-----:|:-----:|
11
-
| namespace | A namespace that is appended to the `site_name-artifactory.` variable. This minimises S3 bucket naming collisions. |string| n/a | yes |
12
-
| 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 |
13
-
| force\_destroy | Controls if all objects in a bucket should be deleted when destroying the bucket resource. If set to `false`, the bucket resource cannot be destroyed until all objects are deleted. Defaults to `true`. |string|`"true"`| no |
14
-
| tags | A map of additional tags to add to the artifactory resource. A name tag with the value `<site_name>-artifactory.<namespace>` is added by default. | map |`<map>`| no |
16
+
|------|-------------|------|---------|:-----:|
17
+
| namespace | A namespace that is appended to the `site_name-artifactory.` variable. This minimises S3 bucket naming collisions. |`any`| n/a | yes |
18
+
| 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. |`any`| n/a | yes |
19
+
| force\_destroy | Controls if all objects in a bucket should be deleted when destroying the bucket resource. If set to `false`, the bucket resource cannot be destroyed until all objects are deleted. Defaults to `true`. |`bool`|`true`| no |
20
+
| tags | A map of additional tags to add to the artifactory resource. A name tag with the value `<site_name>-artifactory.<namespace>` is added by default. |`map(any)`|`{}`| no |
Copy file name to clipboardExpand all lines: artifactory/vars.tf
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,12 @@ variable "namespace" {
8
8
9
9
variable"force_destroy" {
10
10
description="Controls if all objects in a bucket should be deleted when destroying the bucket resource. If set to `false`, the bucket resource cannot be destroyed until all objects are deleted. Defaults to `true`."
11
+
type=bool
11
12
default=true
12
13
}
13
14
14
15
variable"tags" {
15
16
description="A map of additional tags to add to the artifactory resource. A name tag with the value `<site_name>-artifactory.<namespace>` is added by default."
0 commit comments