Skip to content

Commit 54e537a

Browse files
committed
Update input and output descriptions
1 parent d557ea2 commit 54e537a

File tree

2 files changed

+21
-20
lines changed

2 files changed

+21
-20
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,13 @@ module "s3-static-website" {
3939

4040
| Name | Description | Type | Default | Required |
4141
|------|-------------|:----:|:-------:|:--------:|
42-
| cert_arn | The ARN of the SSL Certificate to use for this domain | string | - | yes |
43-
| domain_name | Domain name for the S3 Static Website | string | - | yes |
44-
| redirects | Optional list of domains that should redirect to `domain_name` (i.e. for redirecting naked domain to www-version) | list | `<list>` | no |
45-
| secret | Random alphanumeric string for allowing CloudFront Distribution's traffic to S3 | string | - | yes |
46-
| tags | A mapping of tags to assign to each resource (S3 and CloudFront) | map | `<map>` | no |
47-
| zone_id | The Route 53 Zone ID in which to create the record set | string | - | yes |
42+
| cert_arn | ARN of the SSL Certificate to use for the Cloudfront Distribution | string | - | yes |
43+
| domain_name | Domain name for the website (i.e. `www.example.com`) | string | - | yes |
44+
| public_dir | Directory in S3 Bucket from which to serve public files | string | `/public` | no |
45+
| redirects | A list of domains that should redirect to domain_name (i.e. for redirecting naked domain to www-version) | list | `<list>` | no |
46+
| secret | A secret string between CloudFront and S3 to control access | string | - | yes |
47+
| tags | A mapping of tags to assign to each resource | map | `<map>` | no |
48+
| zone_id | ID of the Route 53 Hosted Zone in which to create an alias record set | string | - | yes |
4849

4950
## Outputs
5051

variables.tf

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
variable "domain_name" {
2-
description = "Domain name for the website (i.e. www.example.com)"
1+
variable "cert_arn" {
2+
description = "ARN of the SSL Certificate to use for the Cloudfront Distribution"
33
type = "string"
44
}
55

6-
variable "redirects" {
7-
description = "A list of domain names which redirect to domain_name"
8-
default = []
6+
variable "domain_name" {
7+
description = "Domain name for the website (i.e. www.example.com)"
8+
type = "string"
99
}
1010

1111
variable "public_dir" {
12-
description = "Directory from which to serve public files (default: /public)"
12+
description = "Directory in S3 Bucket from which to serve public files"
1313
default = "/public"
1414
}
1515

16+
variable "redirects" {
17+
description = "A list of domains that should redirect to domain_name (i.e. for redirecting naked domain to www-version)"
18+
default = []
19+
}
20+
1621
variable "secret" {
1722
description = "A secret string between CloudFront and S3 to control access"
1823
type = "string"
1924
}
2025

21-
variable "cert_arn" {
22-
description = "ARN of the SSL Certificate to use for the Cloudfront Distribution"
23-
type = "string"
26+
variable "tags" {
27+
description = "A mapping of tags to assign to each resource"
28+
default = {}
2429
}
2530

2631
variable "zone_id" {
2732
description = "ID of the Route 53 Hosted Zone in which to create an alias record"
2833
type = "string"
2934
}
30-
31-
variable "tags" {
32-
description = "A map of tags to add to all resources"
33-
default = {}
34-
}

0 commit comments

Comments
 (0)