Skip to content

Commit

Permalink
Update input and output descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
conortm committed Aug 27, 2018
1 parent d557ea2 commit 54e537a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 20 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,13 @@ module "s3-static-website" {

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

## Outputs

Expand Down
28 changes: 14 additions & 14 deletions variables.tf
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
variable "domain_name" {
description = "Domain name for the website (i.e. www.example.com)"
variable "cert_arn" {
description = "ARN of the SSL Certificate to use for the Cloudfront Distribution"
type = "string"
}

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

variable "public_dir" {
description = "Directory from which to serve public files (default: /public)"
description = "Directory in S3 Bucket from which to serve public files"
default = "/public"
}

variable "redirects" {
description = "A list of domains that should redirect to domain_name (i.e. for redirecting naked domain to www-version)"
default = []
}

variable "secret" {
description = "A secret string between CloudFront and S3 to control access"
type = "string"
}

variable "cert_arn" {
description = "ARN of the SSL Certificate to use for the Cloudfront Distribution"
type = "string"
variable "tags" {
description = "A mapping of tags to assign to each resource"
default = {}
}

variable "zone_id" {
description = "ID of the Route 53 Hosted Zone in which to create an alias record"
type = "string"
}

variable "tags" {
description = "A map of tags to add to all resources"
default = {}
}

0 comments on commit 54e537a

Please sign in to comment.