|
| 1 | +<!-- BEGIN_TF_DOCS --> |
| 2 | +# AWS Static Website Terraform Module |
| 3 | + |
| 4 | +## What does it do? |
| 5 | + |
| 6 | +Creates a static website with all the necessary dependencies: |
| 7 | + |
| 8 | +- S3 Bucket |
| 9 | +- S3 Bucket Website Configuration |
| 10 | +- IAM user with deploy permissions |
| 11 | +- Validated ACM cert (in us-east-1) |
| 12 | +- CloudFront distribution |
| 13 | +- DNS record for domain name |
| 14 | + |
| 15 | +**Currently, only supports Cloudflare for DNS records** |
| 16 | + |
| 17 | +## Requirements |
| 18 | + |
| 19 | +| Name | Version | |
| 20 | +|------|---------| |
| 21 | +| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.15, < 5.0 | |
| 22 | +| <a name="requirement_cloudflare"></a> [cloudflare](#requirement\_cloudflare) | >= 3.15, < 4.0 | |
| 23 | + |
| 24 | +## Providers |
| 25 | + |
| 26 | +| Name | Version | |
| 27 | +|------|---------| |
| 28 | +| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.15, < 5.0 | |
| 29 | +| <a name="provider_cloudflare"></a> [cloudflare](#provider\_cloudflare) | >= 3.15, < 4.0 | |
| 30 | + |
| 31 | +## Modules |
| 32 | + |
| 33 | +| Name | Source | Version | |
| 34 | +|------|--------|---------| |
| 35 | +| <a name="module_certificate"></a> [certificate](#module\_certificate) | smartassistco/cloudflare-validated-acm/aws | n/a | |
| 36 | +| <a name="module_s3website"></a> [s3website](#module\_s3website) | smartassistco/s3website/aws | n/a | |
| 37 | + |
| 38 | +## Resources |
| 39 | + |
| 40 | +| Name | Type | |
| 41 | +|------|------| |
| 42 | +| [aws_cloudfront_distribution.cloudfront_distribution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_distribution) | resource | |
| 43 | +| [cloudflare_record.dns_record](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/record) | resource | |
| 44 | + |
| 45 | +## Inputs |
| 46 | + |
| 47 | +| Name | Description | Type | Default | Required | |
| 48 | +|------|-------------|------|---------|:--------:| |
| 49 | +| <a name="input_cloudflare_zone_id"></a> [cloudflare\_zone\_id](#input\_cloudflare\_zone\_id) | The Zone ID for the DNS provider | `string` | n/a | yes | |
| 50 | +| <a name="input_domain_name"></a> [domain\_name](#input\_domain\_name) | The domain name for the website, e.g. demo.example.com | `string` | n/a | yes | |
| 51 | +| <a name="input_error_file"></a> [error\_file](#input\_error\_file) | The name of the error file in the S3 bucket | `string` | `"404.html"` | no | |
| 52 | +| <a name="input_index_file"></a> [index\_file](#input\_index\_file) | The name of the error file in the S3 bucket | `string` | `"index.html"` | no | |
| 53 | +| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | The name of the project, which will be used to create the S3 bucket and deploy user. e.g. demo-website | `string` | n/a | yes | |
| 54 | + |
| 55 | +## Outputs |
| 56 | + |
| 57 | +| Name | Description | |
| 58 | +|------|-------------| |
| 59 | +| <a name="output_deploy_bucket"></a> [deploy\_bucket](#output\_deploy\_bucket) | The S3 bucket to deploy the website files | |
| 60 | +| <a name="output_deploy_user_creds"></a> [deploy\_user\_creds](#output\_deploy\_user\_creds) | The AWS credentials for the deploy user | |
| 61 | +<!-- END_TF_DOCS --> |
0 commit comments