diff --git a/README.md b/README.md index eb547d7..bdb201c 100644 --- a/README.md +++ b/README.md @@ -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 | `` | 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" +} +```