From 8dc3bb7181bce002a34e0dbb62f36066b62b48ec Mon Sep 17 00:00:00 2001 From: Brian Ojeda <9335829+sgtoj@users.noreply.github.com> Date: Mon, 31 Jul 2023 19:30:49 +0000 Subject: [PATCH] docs: update usages and inputs sections --- README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 72969a8..4c9283f 100755 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ be determined in advance. ```hcl module "s3_zip_uploader" { - source = "sgtoj/s3-zip-uploader/aws" + source = "cruxstack/s3-zip-uploader/aws" version = "x.x.x" artifact_src_local_path = "/path/to/yourfile.zip" @@ -29,13 +29,13 @@ module "s3_zip_uploader" { } ``` -## Requirements - -- Terraform 0.13 or newer -- AWS provider 4.0 or newer - ## Inputs +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](https://registry.terraform.io/modules/cloudposse/label/null/latest) +for more details on these variables. + | 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 | @@ -44,13 +44,6 @@ module "s3_zip_uploader" { | `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 | -### Note - -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](https://registry.terraform.io/modules/cloudposse/label/null/latest) -for more details on these variables. - ## Outputs _This module does not currently provide any outputs._