This Terraform module is a utility for uploading the contents of a ZIP file to an AWS S3 bucket. It's especially useful when you need to manage an unknown number of files at plan time, a scenario where Terraform's built-in capabilities fall short.
- Handles an unknown number of files at plan time by working with ZIP files.
- Uploads a ZIP file from a local path to an S3 bucket.
- Unzips the ZIP file and uploads its contents to an S3 bucket.
- Provides customizable options for bucket names and paths.
- Automatically creates and configures necessary AWS resources.
This module offers a handy solution for deploying static websites, managing large data sets, and handling other situations where the number of files can't be determined in advance.
module "s3_zip_uploader" {
source = "sgtoj/s3-zip-uploader/aws"
version = "x.x.x"
artifact_src_local_path = "/path/to/yourfile.zip"
artifact_dst_bucket_arn = "arn:aws:s3:::yourdestinationbucket"
}- Terraform 0.13 or newer
- AWS provider 4.0 or newer
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
artifact_src_bucket_arn |
The ARN of the S3 bucket where the source artifact zip file will be stored. If not provided, the source bucket is assumed to be the same as the destination bucket. | string | "" |
No |
artifact_src_bucket_path |
The path within the S3 bucket where the source artifact zip file will be located. | string | "__upload__/artifact.zip" |
No |
artifact_src_local_path |
The local path of the artifact zip file on the machine where Terraform is executed. | string | N/A | Yes |
artifact_dst_bucket_arn |
The ARN of the destination S3 bucket where the contents of the zip file will be uploaded. | string | N/A | Yes |
artifact_dst_bucket_path |
The path within the destination S3 bucket where the contents of the zip file will be uploaded. | string | "/" |
No |
This module uses the cloudposse/label/null module for naming and tagging
resources. As such, it also includes a context.tf file with additional
optional variables you can set. Refer to the cloudposse/label documentation
for more details on these variables.
This module does not currently provide any outputs.
We welcome contributions to this project. For information on setting up a development environment and how to make a contribution, see CONTRIBUTING documentation.