terraform.aws-baseline-infra/modules/storage/infra-s3-bucket/README.md

20 lines
1.1 KiB
Markdown
Raw Normal View History

2021-01-29 16:21:17 +08:00
# Overview
2021-01-29 17:35:45 +08:00
This module creates s3 bucket using default settings and AWS AES256 encryption
The bucket is meant for infrastructure use. Versioning is off and object expires in 90 days
2021-01-29 16:21:17 +08:00
## Inputs:
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:-----:|
| application | name of application | string | none | yes |
| environment | capacity of environment (prd/dev/lab) | string | none | yes |
| customer-name | owner of aws resources | string | none | yes |
| project | name of project | string | none | yes |
| default-tags | tags to be added to resources | list | none | yes |
| aws-region-short | short name of aws region (e.g. apne1) | string | none | yes |
| bucket-name | name or prefix of s3 bucket | string | none | yes |
| add-random-suffix | Whether to append a random string to bucket name | bool | false | no |
| bucket-policy-json | bucket policy | json | none | yes |
2021-01-29 17:35:45 +08:00
| enable-bucket-versioning | Whether to enable bucket versioning | bool | false | no |
| bucket-retain-days | Days before s3 objects are expired on s3 | number | 90 | no |
2021-01-29 16:21:17 +08:00