Skip to content

Commit

Permalink
Merge pull request #2 from byu-oit/rel-1.0.0
Browse files Browse the repository at this point in the history
updated README for release 1.0.0
  • Loading branch information
yoshutch authored Dec 5, 2019
2 parents e3c3d15 + 0b53dbf commit 371e5e0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Backend-S3
# Terraform AWS Backend S3
Terraform module that creates an S3 bucket and DynamoDB table for backend state files.

## Usage
```hcl
module "backend-s3" {
source = "github.com/byu-oit/terraform-aws-backend-s3"
version = "1.0.0"
}
```

Expand All @@ -22,13 +23,19 @@ terraform {
to configure your terraform backend to the newly created S3 bucket and DynamoDB table.


## Input Variables
## Input
| Variable | Default | Description |
| --- | --- | --- |
| bucket_name | terraform-state-<account_number> | S3 bucket name for state file storage |
| dynamodb_table_name | terraform-state-lock-<account_number> | DynamoDB table name for state file locking|

## Output Variables
* s3_bucket (S3 object)
* s3_bucket_name
* dynamodb_table (DynamoDB object)
## Output
| Name | Description |
| --- | --- |
| s3_bucket | S3 bucket [object](https://www.terraform.io/docs/providers/aws/r/s3_bucket.html#attributes-reference) for terraform state storage |
| s3_bucket_name | Bucket name of the `s3_bucket` |
| dynamodb_table | DynamoDB Table [object](https://www.terraform.io/docs/providers/aws/r/dynamodb_table.html#attributes-reference) for locking of terraform state |

**Note about returning objects:** Because objects are returned (as opposed to just values), autocomplete may not work.
Just add on the key to the end out the output accessor. Even though autocomplete won't work, those values will still be
correctly returned.
1 change: 1 addition & 0 deletions examples/example.tf
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ provider "aws" {

module "backend-s3" {
source = "../"
version = "1.0.0"
}

output "s3" {
Expand Down

0 comments on commit 371e5e0

Please sign in to comment.