Skip to content

Commit

Permalink
Add missing description for variables (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
@SweetOps @const-bon
SweetOps authored and const-bon committed Sep 19, 2017
1 parent 2222a77 commit 127a252
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 18 deletions.
36 changes: 19 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,25 @@ module "log_storage" {


## Variables
| Name | Default | Description | Required |
|:------------------------------------|:-------------------:|:----------------------------------------------------------------------------------------|:--------:|
| `namespace` | `` | Namespace (e.g. `cp` or `cloudposse`) | Yes |
| `stage` | `` | Stage (e.g. `prod`, `dev`, `staging`) | Yes |
| `name` | `` | Name (e.g. `log`) | Yes |
| `acl` | `log-delivery-write`| The canned ACL to apply | No |
| `policy` | `` | A valid bucket policy JSON document | No |
| `prefix` | `` | Object key prefix identifying one or more objects to which the lifecycle rule applies | No |
| `region` | `` | If specified, the AWS region this bucket should reside in. Defaults to region of callee.| No |
| `force_destroy` | `` | All objects will be forcefully deleted from the bucket when bucket destroyed | No |
| `lifecycle_rule_enabled` | `true` | Enable object lifecycle rules on this bucket | No |
| `versioning_enabled` | `false` | Versioning is a means of keeping multiple variants of an object in the same bucket | No |
| `noncurrent_version_transition_days`| `30` | Number of days to persist in the standard storage tier before moving to the glacier tier| No |
| `noncurrent_version_expiration_days`| `90` | Specifies when noncurrent object versions expire | No |
| `standard_transition_days` | `30` | Number of days to persist in the standard storage tier before moving to the glacier tier| No |
| `glacier_transition_days` | `60` | Number of days after which to move the data to the glacier storage tier | No |
| `expiration_days` | `90` | Number of days after which to expunge the objects | No |
| Name | Default | Description | Required |
|:------------------------------------|:-------------------:|:---------------------------------------------------------------------------------------------------|:--------:|
| `namespace` | `` | Namespace (e.g. `cp` or `cloudposse`) | Yes |
| `stage` | `` | Stage (e.g. `prod`, `dev`, `staging`) | Yes |
| `name` | `` | Name (e.g. `log`) | Yes |
| `attributes` | `[]` | Additional attributes (e.g. `policy` or `role`) | No |
| `tags` | `{}` | Additional tags (e.g. `map("BusinessUnit","XYZ")` | No |
| `acl` | `log-delivery-write`| The canned ACL to apply | No |
| `policy` | `` | A valid bucket policy JSON document | No |
| `prefix` | `` | Object key prefix identifying one or more objects to which the lifecycle rule applies | No |
| `region` | `` | If specified, the AWS region this bucket should reside in. Defaults to region of callee. | No |
| `force_destroy` | `` | All objects will be forcefully deleted from the bucket when bucket destroyed | No |
| `lifecycle_rule_enabled` | `true` | Enable object lifecycle rules on this bucket | No |
| `versioning_enabled` | `false` | Versioning is a means of keeping multiple variants of an object in the same bucket | No |
| `noncurrent_version_transition_days`| `30` | Number of days to persist in the standard storage tier before moving to the glacier tier | No |
| `noncurrent_version_expiration_days`| `90` | Specifies when noncurrent object versions expire | No |
| `standard_transition_days` | `30` | Number of days to persist in the standard storage tier before moving to the infrequent access tier | No |
| `glacier_transition_days` | `60` | Number of days after which to move the data to the glacier storage tier | No |
| `expiration_days` | `90` | Number of days after which to expunge the objects | No |

## Outputs

Expand Down
2 changes: 1 addition & 1 deletion variables.tf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ variable "noncurrent_version_transition_days" {
}

variable "standard_transition_days" {
description = "Number of days to persist in the standard storage tier before moving to the glacier tier"
description = "Number of days to persist in the standard storage tier before moving to the infrequent access tier"
default = "30"
}

Expand Down

0 comments on commit 127a252

Please sign in to comment.