Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
snemetz committed Dec 3, 2017
1 parent 77ed1a2 commit 0ee3124
Showing 1 changed file with 16 additions and 40 deletions.
56 changes: 16 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,16 @@
AWS S3 Terraform Module
=====================

Create AWS S3 bucket and set policy

Usage:
------

module "s3" {
source = "../tf_s3"
name = "apps"
environment = "dev01"
}


## Inputs

| Name | Description | Default | Required |
|------|-------------|:-----:|:-----:|
| environment | Environment (ex: dev, qa, stage, prod) | - | yes |
| name | Name | - | yes |
| namespaced | Namespace all resources (prefixed with the environment)? | `true` | no |
| principal | principal | - | yes |
| tags | A map of tags to add to all resources | `<map>` | no |

## Outputs

| Name | Description |
|------|-------------|
| s3_bucket_arn | AWS S3 Bucket ARN |
| s3_bucket_domain_name | AWS S3 Bucket Domain Name |
| s3_bucket_hosted_zone_id | AWS S3 Bucket Hosted Zone ID |
| s3_bucket_id | AWS S3 Bucket ID |
| s3_bucket_name | AWS S3 Bucket Name |
| s3_bucket_region | AWS S3 Bucket Region |


### Resource Graph

![Terraform Graph](graph.png)
AWS S3 Bucket Terraform module
========================

Terraform module which creates S3 buckets on AWS.

Usage
-----

```hcl
module "s3-buckets" {
source = "devops-workflow/s3-bucket/aws"
names = ["bucket-1", "bucket2", "bucket_3"]
environment = "dev"
org = "corp"
}
```

0 comments on commit 0ee3124

Please sign in to comment.