From 9623b77133594ce6d50c57ed0f7ed98817f286f4 Mon Sep 17 00:00:00 2001 From: badra001 Date: Thu, 30 Jul 2020 21:04:57 -0400 Subject: [PATCH] update docs --- README.md | 31 +++++++++++++++++++++++++++++++ main.tf | 2 ++ 2 files changed, 33 insertions(+) diff --git a/README.md b/README.md index e69de29..44b1485 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,31 @@ += Usage = +module "mybucket" { + source = "git@github.e.it.census.gov:terraform-modules/aws-t26-s3.git" + + bucket\_name = "myt26bucket" +} + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| aws | n/a | +| null | n/a | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| access\_log\_bucket\_prefix | Access log bucket prefix, to which the bucket name will be appended to make the target\_prefix | `string` | `"s3"` | no | +| bucket\_folders | List of folders (keys) to create after creation of bucket | `list(string)` | `[]` | no | +| bucket\_name | AWS Bucket Name | `string` | n/a | yes | +| kms\_key\_id | AWS KMS Key ID (one per bucket) | `string` | `""` | no | +| tags | AWS Tags | `map(string)` | `{}` | no | + +## Outputs + +No output. diff --git a/main.tf b/main.tf index f106704..9d2fa45 100644 --- a/main.tf +++ b/main.tf @@ -2,6 +2,8 @@ * = Usage = * module "mybucket" { * source = "git@github.e.it.census.gov:terraform-modules/aws-t26-s3.git" + * + * bucket_name = "myt26bucket" * } * */