From 6b3512677a3faf7a8e1f978db18a37036a86f8b2 Mon Sep 17 00:00:00 2001
From: badra001 <donald.e.badrak.ii@census.gov>
Date: Wed, 4 Nov 2020 14:44:30 -0500
Subject: [PATCH] add README in each dir

---
 common/README.md   | 34 ++++++++++++++++++++++++++++++++++
 standard/README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 title26/README.md  | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 126 insertions(+)
 create mode 100644 common/README.md
 create mode 100644 standard/README.md
 create mode 100644 title26/README.md

diff --git a/common/README.md b/common/README.md
new file mode 100644
index 0000000..cf6e832
--- /dev/null
+++ b/common/README.md
@@ -0,0 +1,34 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | n/a |
+| null | n/a |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| \_module\_version | Module version number | `string` | `"2.0"` | no |
+| access\_log\_bucket | Server Access Logging Bucket ID | `string` | n/a | yes |
+| access\_log\_bucket\_prefix | Access log bucket prefix, to which the bucket name will be appended to make the target\_prefix | `string` | `"s3"` | no |
+| allowed\_cidr | List of allowed source IPs (NOT from within the VPC) | `list(string)` | `[]` | no |
+| allowed\_endpoints | List of allowed VPC endpoint IDs | `list(string)` | `[]` | 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 |
+| force\_destroy | Sets force\_destroy to allow the bucket and contents to be deleted.  The deletion may take a very long time | `bool` | `false` | no |
+| kms\_key\_id | AWS KMS Key ID (one per bucket) | `string` | `""` | no |
+| tags | AWS Tags | `map(string)` | `{}` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| kms\_key\_arn | Created KMS Key ARN |
+| kms\_key\_id | Created KMS Key ID |
+| s3\_bucket\_arn | Created S3 Bucket ARN |
+| s3\_bucket\_id | Created S3 Bucket ID |
diff --git a/standard/README.md b/standard/README.md
new file mode 100644
index 0000000..3e23dd2
--- /dev/null
+++ b/standard/README.md
@@ -0,0 +1,46 @@
+# About aws-s3
+
+# Usage
+
+```hcl
+module "mybucket" {
+  source = "git@github.e.it.census.gov:terraform-modules/aws-s3//standard"
+
+  bucket_name = "mynormalbucket"
+}
+```
+
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | n/a |
+| null | n/a |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| \_module\_version | Module version number | `string` | `"2.0"` | no |
+| access\_log\_bucket | Server Access Logging Bucket ID | `string` | n/a | yes |
+| access\_log\_bucket\_prefix | Access log bucket prefix, to which the bucket name will be appended to make the target\_prefix | `string` | `"s3"` | no |
+| allowed\_cidr | List of allowed source IPs (NOT from within the VPC) | `list(string)` | `[]` | no |
+| allowed\_endpoints | List of allowed VPC endpoint IDs | `list(string)` | `[]` | 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 |
+| force\_destroy | Sets force\_destroy to allow the bucket and contents to be deleted.  The deletion may take a very long time | `bool` | `false` | no |
+| kms\_key\_id | AWS KMS Key ID (one per bucket) | `string` | `""` | no |
+| tags | AWS Tags | `map(string)` | `{}` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| kms\_key\_arn | Created KMS Key ARN |
+| kms\_key\_id | Created KMS Key ID |
+| s3\_bucket\_arn | Created S3 Bucket ARN |
+| s3\_bucket\_id | Created S3 Bucket ID |
diff --git a/title26/README.md b/title26/README.md
new file mode 100644
index 0000000..c529a1d
--- /dev/null
+++ b/title26/README.md
@@ -0,0 +1,46 @@
+# About aws-s3
+
+# Usage
+
+```hcl
+module "mybucket" {
+  source = "git@github.e.it.census.gov:terraform-modules/aws-s3//title26"
+
+  bucket_name = "myt26bucket"
+}
+```
+
+## Requirements
+
+No requirements.
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | n/a |
+| null | n/a |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| \_module\_version | Module version number | `string` | `"2.0"` | no |
+| access\_log\_bucket | Server Access Logging Bucket ID | `string` | n/a | yes |
+| access\_log\_bucket\_prefix | Access log bucket prefix, to which the bucket name will be appended to make the target\_prefix | `string` | `"s3"` | no |
+| allowed\_cidr | List of allowed source IPs (NOT from within the VPC) | `list(string)` | `[]` | no |
+| allowed\_endpoints | List of allowed VPC endpoint IDs | `list(string)` | `[]` | 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 |
+| force\_destroy | Sets force\_destroy to allow the bucket and contents to be deleted.  The deletion may take a very long time | `bool` | `false` | no |
+| kms\_key\_id | AWS KMS Key ID (one per bucket) | `string` | `""` | no |
+| tags | AWS Tags | `map(string)` | `{}` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| kms\_key\_arn | Created KMS Key ARN |
+| kms\_key\_id | Created KMS Key ID |
+| s3\_bucket\_arn | Created S3 Bucket ARN |
+| s3\_bucket\_id | Created S3 Bucket ID |