Public Static Website

Deploy your static content and static websites on S3, using a CloudFront CDN. Supports bucket versioning, redirects, and access logging.

View on GitHub

Reference

Inputs

• acm_certificate_domain_name — The domain name for which an ACM cert has been issued (e.g. *.foo.com). Only used if create_route53_entry is true. Set to blank otherwise.

• base_domain_name — The domain name associated with a hosted zone in Route 53. Usually the base domain name of website_domain_name (e.g. foo.com). This is used to find the hosted zone that will be used for the CloudFront distribution. If create_route53_entry is true, one of base_domain_name or hosted_zone_id must be provided.

• base_domain_name_tags — The tags associated with base_domain_name. If there are multiple hosted zones for the same base_domain_name, this will help filter the hosted zones so that the correct hosted zone is found.

• create_route53_entry — If set to true, create a DNS A Record in Route 53. If create_route53_entry is true, one of base_domain_name or hosted_zone_id must be provided.

• custom_tags — A map of custom tags to apply to the S3 bucket containing the website and the CloudFront distribution created for it. The key is the tag name and the value is the tag value.

• default_ttl — The default amount of time, in seconds, that an object is in a CloudFront cache before CloudFront forwards another request in the absence of an 'Cache-Control max-age' or 'Expires' header.

• error_document — The path to the error document in the S3 bucket (e.g. error.html).

• force_destroy — If set to true, this will force the delete of the website, redirect, and access log S3 buckets when you run terraform destroy, even if there is still content in those buckets. This is only meant for testing and should not be used in production.

• geo_locations_list — The ISO 3166-1-alpha-2 codes for which you want CloudFront either to distribute your content (if geo_restriction_type is whitelist) or not distribute your content (if geo_restriction_type is blacklist).

• geo_restriction_type — The method that you want to use to restrict distribution of your content by country: none, whitelist, or blacklist.

• hosted_zone_id — The ID of the Route 53 Hosted Zone in which to create the DNS A Records specified in website_domain_name. If create_route53_entry is true, one of base_domain_name or hosted_zone_id must be provided.

• index_document — The path to the index document in the S3 bucket (e.g. index.html).

• max_ttl — The maximum amount of time, in seconds, that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. Only effective in the presence of 'Cache-Control max-age', 'Cache-Control s-maxage', and 'Expires' headers.

• min_ttl — The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.

• routing_rules — A json array containing routing rules describing redirect behavior and when redirects are applied. For routing rule syntax, see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-websiteconfiguration-routingrules.html. This will only be used if should_redirect_all_requests is false

• viewer_protocol_policy — Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. One of allow-all, https-only, or redirect-to-https.

• website_domain_name — The name of the website and the S3 bucket to create (e.g. static.foo.com).

Outputs

• cloudfront_access_logs_bucket_arn — The ARN of the created S3 bucket associated with the website's CloudFront access logs.

• cloudfront_domain_names — The domain names created for the CloudFront Distribution. Should be the same as the input website_domain_name.

• cloudfront_id — The CloudFront ID of the created CloudFront Distribution.

• website_access_logs_bucket_arn — The ARN of the created S3 bucket associated with the website access logs.

• website_s3_bucket_arn — The ARN of the created S3 bucket associated with the website.