Skip to content

Commit

Permalink
update main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
badra001 committed Dec 17, 2020
1 parent bad7e1c commit 1036823
Showing 1 changed file with 18 additions and 34 deletions.
52 changes: 18 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,30 @@
# About aws-t26-s3
# About aws-s3

This module allows you to create an S3 bucket, either a standard bucket or a bucket used for FTI (Title26)
data.

# Usage

* [Standard](standard)

```hcl
module "mybucket" {
source = "git@github.e.it.census.gov:terraform-modules/aws-t26-s3.git"
source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard"
bucket_name = "myt26bucket"
bucket_name = "mynormalbucket"
access_log_bucket = "accesslogs"
}
```

## Requirements

No requirements.

## Providers

| Name | Version |
|------|---------|
| aws | n/a |
| null | n/a |
* [Title 26](title26)

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| \_module\_version | Module version number | `string` | `"1.2"` | 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 |
```hcl
module "mybucket" {
source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//title26"
## Outputs
bucket_name = "mytitle26bucket"
access_log_bucket = "accesslogs"
}
```

| 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 |
See each section for additional information.

0 comments on commit 1036823

Please sign in to comment.