https://github.com/unfunco/terraform-aws-static-website
Terraform module to create static websites in S3 with CloudFront.
https://github.com/unfunco/terraform-aws-static-website
acm aws cloudfront cloudfront-distribution s3 s3-website static-site static-website terraform
Last synced: 5 months ago
JSON representation
Terraform module to create static websites in S3 with CloudFront.
- Host: GitHub
- URL: https://github.com/unfunco/terraform-aws-static-website
- Owner: unfunco
- License: apache-2.0
- Created: 2023-03-08T18:25:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-18T10:18:44.000Z (over 3 years ago)
- Last Synced: 2025-02-07T14:45:13.795Z (over 1 year ago)
- Topics: acm, aws, cloudfront, cloudfront-distribution, s3, s3-website, static-site, static-website, terraform
- Language: HCL
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# terraform-aws-static-website
[](https://github.com/unfunco/terraform-aws-static-website/actions/workflows/ci.yaml)
[](https://registry.terraform.io/modules/unfunco/static-website/aws)
[](LICENSE.md)
Terraform module for [AWS] static website hosting with [S3], [CloudFront] CDN,
automatic SSL/TLS certificates, HTTP/3, IPv6, and secure defaults using
[Origin Access Control] (OAC).
## Getting started
### Requirements
- [Terraform] 1.14+ and the [AWS provider] 6.0+
### Installation and usage
```terraform
module "website" {
source = "unfunco/static-website/aws"
version = "0.5.0"
domain_name = "unfun.co"
}
```
#### IAM
Use the bundled `modules/ci-iam-policy` module to generate an inline IAM policy
document for your CI role. The module has two boolean inputs to control which
permissions are included, `attach_content_permissions` is enough for deploy jobs
that sync website content and invalidate CloudFront, while
`attach_infrastructure_permissions` is for Terraform jobs that create or update
AWS resources.
```terraform
module "ci_iam_policy_deploy" {
source = "unfunco/static-website/aws//modules/ci-iam-policy"
version = "0.5.0"
attach_content_permissions = true
attach_infrastructure_permissions = false
bucket_name = module.website.bucket_name
cloudfront_distribution_arn = module.website.cloudfront_distribution_arn
}
```
```terraform
module "oidc_github" {
source = "unfunco/oidc-github/aws"
version = "2.0.2"
github_repositories = ["unfunco/unfun.co"]
iam_role_inline_policies = {
deploy = module.ci_iam_policy_deploy.policy_document
}
}
```
### Resources
| Name | Type |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [aws_acm_certificate.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acm_certificate) | resource |
| [aws_cloudfront_distribution.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_distribution) | resource |
| [aws_cloudfront_origin_access_control.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_origin_access_control) | resource |
| [aws_s3_bucket.logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
| [aws_s3_bucket.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
| [aws_s3_bucket_lifecycle_configuration.logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_lifecycle_configuration) | resource |
| [aws_s3_bucket_logging.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_logging) | resource |
| [aws_s3_bucket_object_lock_configuration.logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object_lock_configuration) | resource |
| [aws_s3_bucket_ownership_controls.logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_ownership_controls) | resource |
| [aws_s3_bucket_ownership_controls.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_ownership_controls) | resource |
| [aws_s3_bucket_policy.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |
| [aws_s3_bucket_public_access_block.logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
| [aws_s3_bucket_public_access_block.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
| [aws_s3_bucket_versioning.logs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
| [aws_s3_bucket_versioning.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
| [aws_s3_object.error_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_object) | resource |
| [aws_s3_object.index_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_object) | resource |
| [aws_iam_policy_document.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
| [aws_partition.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/partition) | data source |
### Inputs
| Name | Description | Type | Default | Required |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | :------: |
| acm_certificate_arn | The ARN of an existing ACM certificate to use for the CloudFront distribution. Required when create_certificate is false. | `string` | `""` | no |
| bucket_name | The name of the S3 bucket for storing website content. | `string` | `""` | no |
| cloudfront_additional_origins | Additional origins to add to the CloudFront distribution, keyed by origin ID. | `map(object({ connection_attempts = optional(number, 3) connection_timeout = optional(number, 10) custom_headers = optional(map(string), {}) domain_name = string origin_access_control_id = optional(string) origin_path = optional(string) use_default_origin_access_control = optional(bool, false) }))` | `{}` | no |
| cloudfront_allowed_methods | The HTTP methods allowed by the CloudFront distribution. | `list(string)` | `[ "GET", "HEAD" ]` | no |
| cloudfront_distribution_arn | The ARN of an existing CloudFront distribution to use for the S3 bucket policy. | `string` | `""` | no |
| cloudfront_distribution_price_class | The price class for the CloudFront distribution. | `string` | `"PriceClass_All"` | no |
| cloudfront_ordered_cache_behaviors | Additional ordered cache behaviors for path-based routing. | `list(object({ allowed_methods = optional(list(string), ["GET", "HEAD"]) cache_policy_id = optional(string, "658327ea-f89d-4fab-a63d-7e88639e58f6") cached_methods = optional(list(string), ["GET", "HEAD"]) compress = optional(bool, true) origin_request_policy_id = optional(string) path_pattern = string response_headers_policy_id = optional(string) target_origin_id = string viewer_protocol_policy = optional(string, "redirect-to-https") }))` | `[]` | no |
| cloudfront_response_headers_policy_id | The ID of a response headers policy to attach to the CloudFront distribution. | `string` | `null` | no |
| cloudfront_retain_on_delete | Whether to retain the CloudFront distribution when deleting the resource. | `bool` | `false` | no |
| cloudfront_web_acl_id | The ID of a WAF web ACL to associate with the CloudFront distribution. | `string` | `null` | no |
| create | Whether to create resources. | `bool` | `true` | no |
| create_certificate | Whether to create an ACM certificate. | `bool` | `true` | no |
| create_cloudfront_distribution | Whether to create a CloudFront distribution. | `bool` | `true` | no |
| create_default_documents | Whether to create default index and error documents. | `bool` | `true` | no |
| create_log_bucket | Whether to create a dedicated logging bucket. | `bool` | `true` | no |
| domain_name | The domain name for the website. | `string` | n/a | yes |
| enable_logging | Whether to enable access logging for S3 and CloudFront. | `bool` | `true` | no |
| enable_versioning | Whether to enable versioning on the S3 bucket. | `bool` | `true` | no |
| error_document | The path to the error document returned for 4xx errors. | `string` | `"error.html"` | no |
| force_destroy | Whether to allow bucket deletion even when not empty. | `bool` | `false` | no |
| index_document | The path to the index document returned for directory requests. | `string` | `"index.html"` | no |
| log_bucket_name | The name of the S3 bucket for storing access logs. | `string` | `""` | no |
| log_bucket_object_lock_days | Default retention period, in days, for object lock on the logging bucket. | `number` | `365` | no |
| log_bucket_object_lock_enabled | Whether to enable S3 Object Lock on the logging bucket. This only applies at bucket creation time. | `bool` | `true` | no |
| log_bucket_object_lock_mode | Default object lock retention mode for the logging bucket. Valid values are GOVERNANCE or COMPLIANCE. | `string` | `"GOVERNANCE"` | no |
| log_bucket_target_prefix | The prefix for log objects in the logging bucket. | `string` | `""` | no |
| tags | The tags to apply to all taggable resources. | `map(string)` | `{}` | no |
### Outputs
| Name | Description |
| ------------------------------------- | ----------------------------------------------------- |
| bucket_arn | The ARN of the S3 bucket. |
| bucket_id | The ID of the S3 bucket. |
| bucket_name | The name of the S3 bucket. |
| certificate_arn | The ARN of the ACM certificate. |
| certificate_domain_validation_options | The domain validation options of the ACM certificate. |
| cloudfront_distribution_arn | The ARN of the CloudFront distribution. |
| cloudfront_distribution_id | The CloudFront distribution ID. |
| cloudfront_domain_name | The CloudFront domain name. |
| cloudfront_hosted_zone_id | The hosted zone ID of the CloudFront distribution. |
## License
© 2023 [Daniel Morris]\
Made available under the terms of the [MIT License].
[aws]: https://aws.amazon.com
[aws provider]: https://registry.terraform.io/providers/hashicorp/aws
[cloudfront]: https://aws.amazon.com/cloudfront
[daniel morris]: https://unfun.co
[mit license]: LICENSE.md
[origin access control]: https://aws.amazon.com/blogs/networking-and-content-delivery/amazon-cloudfront-introduces-origin-access-control-oac/
[s3]: https://aws.amazon.com/s3
[terraform]: https://terraform.io