diff --git a/README.md b/README.md index b44f83e..e294c55 100644 --- a/README.md +++ b/README.md @@ -84,20 +84,17 @@ No Modules. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| acm\_site\_certificate\_arn | ARN of an ACM certificate to use for https on the CloudFront distribution. Required. | `any` | n/a | yes | -| cloudfront\_price\_class | Price class for Cloudfront. Default: PriceClass\_100 | `string` | `"PriceClass_100"` | no | -| create\_cloudfront\_distribution | Defines whether or not to create a CloudFront distribution for the S3 bucket. Default: true. | `bool` | `true` | no | -| create\_public\_dns\_site\_record | If set to true, creates a public DNS record in your site\_tld hosted zone. If you do not already have a hosted zone for this TLD, you should set create\_public\_dns\_zone to true. Otherwise, this will try to create a record in an existing zone or fail. Default: true. | `string` | `"true"` | no | -| create\_public\_dns\_www\_record | Defines whether or not to create a WWW DNS record for the site. Default: false. | `bool` | `false` | no | -| create\_public\_dns\_zone | If set to true, creates a public hosted zone in Route53 for your site. Default: false. | `string` | `"false"` | no | -| create\_sns\_topic | Defines whether or not to create an SNS topic for notifications about events. Default: true. | `bool` | `true` | no | +| acm\_site\_certificate\_arn | ARN of an ACM certificate to use for https on the CloudFront distribution. | `any` | n/a | yes | +| cloudfront\_price\_class | Price class for Cloudfront. | `string` | `"PriceClass_100"` | no | +| create\_cloudfront\_distribution | Defines whether or not to create a CloudFront distribution for the S3 bucket. | `bool` | `true` | no | +| create\_public\_dns\_site\_record | If set to true, creates a public DNS record in your site\_tld hosted zone. If you do not already have a hosted zone for this TLD, you should set create\_public\_dns\_zone to true. Otherwise, this will try to create a record in an existing zone or fail. | `string` | `"true"` | no | +| create\_public\_dns\_www\_record | Defines whether or not to create a WWW DNS record for the site. | `bool` | `false` | no | +| create\_public\_dns\_zone | If set to true, creates a public hosted zone in Route53 for your site. | `string` | `"false"` | no | +| create\_sns\_topic | Defines whether or not to create an SNS topic for notifications about events. | `bool` | `false` | no | | create\_www\_redirect\_bucket | Defines whether or not to create a www redirect S3 bucket. Default: true | `bool` | `true` | no | -| error\_page\_object | The error page object for the Cloudfront/S3 distribution. Default: 404.html | `string` | `"404.html"` | no | -| github\_oauth\_token | Github oauth token | `string` | n/a | yes | +| error\_page\_object | The error page object for the Cloudfront/S3 distribution. | `string` | `"404.html"` | no | | log\_include\_cookies | Defines whether or not CloudFront should log cookies. Default: false. | `bool` | `false` | no | -| root\_page\_object | The root page object for the Cloudfront/S3 distribution. Default: index.html | `string` | `"index.html"` | no | -| site\_branch | Branch to deploy | `string` | `"master"` | no | -| site\_github\_owner | Owner ID of the Github Repo | `string` | n/a | yes | +| root\_page\_object | The root page object for the Cloudfront/S3 distribution. | `string` | `"index.html"` | no | | site\_region | Region in which to provision the site. Default: us-east-1 | `string` | `"us-east-1"` | no | | site\_tld | TLD of the website you want to create. A bucket will be created that is named this. Note that the module will error out if this bucket already exists in AWS. Example: example.com | `any` | n/a | yes | | sns\_topic\_name | Name for the SNS topic. | `string` | `"website-notifications"` | no | diff --git a/variables.tf b/variables.tf index 936a345..458da65 100644 --- a/variables.tf +++ b/variables.tf @@ -10,29 +10,8 @@ variable "create_www_redirect_bucket" { default = true } -# variable "create_codecommit_repo" { -# description = "Defines whether or not to create a CodeCommit repo. Default: true. NOTE: If you choose false, early versions of this module likely require that you fork and modify the code to point the CodeDeploy/CodePipeline stuff to your own repo." -# default = true -# } - -variable "site_github_owner" { - description = "Owner ID of the Github Repo" - type = string -} - -variable "github_oauth_token" { - description = "Github oauth token" - type = string -} - -variable "site_branch" { - description = "Branch to deploy" - type = string - default = "master" -} - variable "create_cloudfront_distribution" { - description = "Defines whether or not to create a CloudFront distribution for the S3 bucket. Default: true." + description = "Defines whether or not to create a CloudFront distribution for the S3 bucket." default = true } @@ -42,8 +21,8 @@ variable "log_include_cookies" { } variable "create_sns_topic" { - description = "Defines whether or not to create an SNS topic for notifications about events. Default: true." - default = true + description = "Defines whether or not to create an SNS topic for notifications about events." + default = false } variable "sns_topic_name" { @@ -56,35 +35,35 @@ variable "site_tld" { } variable "create_public_dns_zone" { - description = "If set to true, creates a public hosted zone in Route53 for your site. Default: false." + description = "If set to true, creates a public hosted zone in Route53 for your site." default = "false" } variable "create_public_dns_site_record" { - description = "If set to true, creates a public DNS record in your site_tld hosted zone. If you do not already have a hosted zone for this TLD, you should set create_public_dns_zone to true. Otherwise, this will try to create a record in an existing zone or fail. Default: true." + description = "If set to true, creates a public DNS record in your site_tld hosted zone. If you do not already have a hosted zone for this TLD, you should set create_public_dns_zone to true. Otherwise, this will try to create a record in an existing zone or fail." default = "true" } variable "create_public_dns_www_record" { - description = "Defines whether or not to create a WWW DNS record for the site. Default: false." + description = "Defines whether or not to create a WWW DNS record for the site." default = false } variable "root_page_object" { - description = "The root page object for the Cloudfront/S3 distribution. Default: index.html" + description = "The root page object for the Cloudfront/S3 distribution." default = "index.html" } variable "error_page_object" { - description = "The error page object for the Cloudfront/S3 distribution. Default: 404.html" + description = "The error page object for the Cloudfront/S3 distribution." default = "404.html" } variable "cloudfront_price_class" { - description = "Price class for Cloudfront. Default: PriceClass_100" + description = "Price class for Cloudfront." default = "PriceClass_100" } variable "acm_site_certificate_arn" { - description = "ARN of an ACM certificate to use for https on the CloudFront distribution. Required." + description = "ARN of an ACM certificate to use for https on the CloudFront distribution." }