@dvargas92495/aws-static-site v3.6.7

aws-static-site

Creates a static website on a domain hosted on S3 and delivered by CloudFront over HTTPS with Route53 managing DNS.

Features

• Redirects the following to the primary domain https://example.com
  • http://example.com
  • http://www.example.com
  • https://www.example.com
• The raw S3 buckets are not publicly accessible.
• A single certificate is issued by the Amazon Certificate Manager for all specified domains - both apex and www.
• An IAM user named like domain.name-deploy is created that is given deployment access to the S3 bucket containing the site data.
• The primary domain can be either https://example.com or https://www.example.com.

Usage

provider "aws" {
    region = "us-east-1"
}

module "aws_static_site" {
    source    = "dvargas92495/aws-static-site/aws"
    countries = ["RU", "CN"]
    secret    = "secret cdn user agent pseudo-password"

    domain = "example.com"

    cdn_settings = {
        price_class              = "PriceClass_100"
        restriction_type         = "blacklist"
        minimum_protocol_version = "TLSv1.2_2018"
    }

    tags = {
      Application = "Example"
    }
    
    providers = {
      aws.us-east-1 = aws
    }
}

Inputs

• domain is a single domain to be built into a static website with a CloudFront front-end.
• secret is the key that is shared between CloudFront and S3 to authorize access.
• www_is_main controls whether the apex domain or the www subdomain is the main site.
• enable_iam_user controls whether the module should create the AWS IAM deployment user.
• tags tags to add on to S3 buckets, CloudFront, and ACM Certificate
• cdn_settings is a map containing some configurable CloudFront settings. These are optional and have sane defaults.
  • price_class - sets the CloudFront price class. Defaults to PriceClass_All.
  • restriction_type - set the geographic restriction type. Defaults to none. If this is set, the countries variable should be set also.
  • minimum_protocol_version - sets the minimum version of TLS that CloudFront will require. See the AWS CloudFront documentation for a full list. Defaults to TLSv1_2016.
  • min_ttl - the minimun time-to-live for content in seconds. Defaults to 0.
  • default_ttl - the default amount of time, in seconds, that objects stay in CloudFront cache before CloudFront requests an updated copy. Defaults to 1 day.
  • max_ttl - the maximum amount of time, in seconds, that objects stay in CloudFront cache. Defaults to 1 year. Further details of all the TTL settings can be found in the AWS CloudFront documentation.
• countries is a list of countries in ISO 3166-alpha-2 country code format that the CloudFront restriction_type applies to.
• allowed_origins is a list of origins to allow getting items from the S3 bucket.
• index is the index page for the website. Defaults to index.html.
• error_page is the error page for the website. Defaults to 404.html.

Outputs

• deploy-id - AWS access key of the deploy user
• deploy-secret - AWS secret access key of the deploy user
• bucket-name - Name of the primary S3 bucket.
• route53_zone_id - The zone id of the given route53 domain
• cloudfront_arn - The ARN of the main cloudfront distribution
• cloudfront_distribution_id - The Distribution Id of the main Cloudfront Distribution

Details

Multiple S3 buckets are created, one main bucket for example.com or www.example.com (depending on how www_is_main is set) which will hold all of the site data and the others for for www.domain.name which is simply a bucket set up to redirect to the first bucket.

A Route 53 hosted zone is assumed to be created and referenced for domain.name. A certificate is issued for domain.name and www.domain.name by automatically adding the appropriate CNAME records to the hosted zone. Then the module waits for the certificate to actually be issued. See the notes section for troubleshooting.

Two CloudFront distributions are created, one for domain.name and one for www.domain.name. Each of them simply points at the respective S3 bucket and uses the certificate created in the previous step.

Once the CloudFront distributions are available, then the A records are created in Route 53 for domain.name and www.domain.name. The A records are simply ALIAS records to the respective CloudFront distributions.

Finally, an IAM user is created, an access key is given to this user, and a policy is attached to the user that only allows the user to modify the domain.name S3 bucket.

Notes

The certificate is created automatically by adding DNS entries to the Route 53 hosted zone. The script will wait up to two hours for the certificate to be issued. If your domain is not owned by Route 53, you may need to go to the Route 53 hosted zone, look at the NS record, and assign your domain those nameservers. If the script times out because this was not done rerunning terraform apply after making sure the nameservers are correct should allow the module to continue.

A provider aws.us-east-1 has to be passed to the module - this is because CloudFront certificates must be requested in us-east-1.