Skip to content

Commit a77c561

Browse files
author
Taylor McClure
committed
added description
1 parent 9f403cf commit a77c561

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# terraform-s3-rbac
22

3-
## Purpose
3+
## Description
44

5-
Terraform module to allow users to easily create buckets in their own account that gives another account's principal(s) full read/write access to their buckets.
5+
This Terraform module allow users to easily create buckets in their own account and then give access to said buckets via AWS IAM principals.
6+
7+
Principals are defined in the AWS docs here: [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html)
8+
9+
#### NOTE
10+
11+
Currently only `AWS` principals are supported this includes:
12+
* IAM Users
13+
* IAM Roles
14+
* AWS Accounts
15+
* Assumed-Role Sessions
616

717
## Usage
818

0 commit comments

Comments
 (0)