Vy Static File Deploy Provider

This provider is used to deploy a set of files from a source ZIP file to a target S3 bucket.

Use this in conjunction with the vy_artifact_version data source to ensure correct versions for you website S3 bucket.

Link to Terraform registry

• Provider setup
• Resource
• Guide: Deploying a static website with a S3 bucket
  • Adding a CloudFront distribution

Provider setup

Start by adding this provider to your configuration:

terraform {
  required_providers {
    staticfiledeploy = {
      source  = "nsbno/static-file-deploy"
      version = "x.y.z"
    }
  }
}

Resource

This provider has one resource, staticfiledeploy_deployment, which is used to deploy static files to a target.

The source S3 bucket is where the static files are uploaded as a ZIP file from the build stage, and the target S3 bucket is where the static files are used, for example as a part of a CloudFront Distribution.

We use this provider to ensure that the target S3 bucket is updated with the correct version of the static files.

The source_version attribute is optional. If specified, it will deploy a specific version of the ZIP file from S3. If omitted, it will always deploy the latest version.

data "vy_artifact_version" "this" {
  application = "petstore"
}

resource "aws_s3_bucket" "website_bucket" {
  bucket = "123456789012-my-cool-bucket"
}

# Deploy a specific version
resource "staticfiledeploy_deployment" "example_deployment" {
  source         = "${data.vy_artifact_version.this.store}/${data.vy_artifact_version.this.path}"
  source_version = data.vy_artifact_version.this.version
  target         = data.aws_s3_bucket.website_bucket.bucket
}

# Or deploy the latest version (source_version is optional)
resource "staticfiledeploy_deployment" "latest_deployment" {
  source = "my-source-bucket/path/to/source.zip"
  target = data.aws_s3_bucket.website_bucket.bucket
}

Guide: Deploying a static website with a S3 bucket

Here is an example of how to deploy a static website with a S3 bucket using the staticfiledeploy_deployment resource.

S3 setup with a website configuration, bucket ownership controls, ACL, and versioning:

resource "aws_s3_bucket" "frontend" {
  bucket = "some-unique-bucket-name"
}

resource "aws_s3_bucket_website_configuration" "website" {
  bucket = aws_s3_bucket.frontend.id

  index_document {
    suffix = "index.html"
  }

  error_document {
    key = "index.html"
  }
}

resource "aws_s3_bucket_ownership_controls" "s3_ownership" {
  bucket = aws_s3_bucket.frontend.id
  rule {
    object_ownership = "BucketOwnerPreferred"
  }
}

resource "aws_s3_bucket_acl" "acl" {
  depends_on = [aws_s3_bucket_ownership_controls.s3_ownership]

  bucket = aws_s3_bucket.frontend.id
  acl    = "private"
}

resource "aws_s3_bucket_versioning" "versioning" {
  bucket = aws_s3_bucket.frontend.id
  versioning_configuration {
    status = "Enabled"
  }
}

Connecting the staticfiledeploy_deployment resource to the S3 bucket:

data "vy_artifact_version" "this" {
  # From the vy_artifact_version data source
  artifact = "frontend"
}

resource "staticfiledeploy_deployment" "this" {
  source         = "${data.vy_artifact_version.this.store}/${data.vy_artifact_version.this.path}"
  source_version = data.vy_artifact_version.this.version

  # Assume we have an existing website bucket
  target = data.aws_s3_bucket.frontend.bucket
}

Adding a CloudFront distribution

When deploying a CloudFront distribution, we can use it with the terraform-aws-multi-domain-static-site resource to easily set up a CloudFront distribution with an ACM Certificate.

In this example we use the existing S3 Bucket defined above. The website_bucket is the target S3 bucket where the static files are deployed and updated by this static-file-deploy provider.

# To use ACM certificates, we need to use add a provider in us-east-1
provider "aws" {
  region = "us-east-1"
  alias  = "certificate_provider"
}

resource "aws_route53_zone" "main" {
  name = "infrademo.vydev.io"
}

module "static-site-with-domain" {
  source    = "github.com/nsbno/terraform-aws-multi-domain-static-site?ref=x.y.z"

  providers = {
    aws.certificate_provider = aws.certificate_provider
  }

  name_prefix         = "static-example"

  use_external_bucket = true
  website_bucket      = data.aws_s3_bucket.frontend.bucket

  domain_name = {
    name = "static.infrademo.vydev.io"
    zone = aws_route53_zone.main.name
  }

  depends_on = [aws_s3_bucket.frontend]  # from example above
}