|
42 | 42 |
|
43 | 43 | [![Cloud Posse][logo]](https://cpco.io/homepage) |
44 | 44 |
|
45 | | -# terraform-aws-iam-s3-user [](https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d12481cc6e335d586a1315d) [](https://github.com/cloudposse/terraform-aws-iam-s3-user/releases/latest) [](https://slack.cloudposse.com) |
| 45 | +# terraform-aws-iam-s3-user [](https://github.com/cloudposse/terraform-aws-iam-s3-user/releases/latest) [](https://slack.cloudposse.com) |
46 | 46 |
|
47 | 47 |
|
48 | 48 | Terraform module to provision a basic IAM user with permissions to access S3 resources, e.g. to give the user read/write/delete access to the objects in an S3 bucket. |
@@ -117,32 +117,47 @@ Available targets: |
117 | 117 | lint Lint terraform code |
118 | 118 |
|
119 | 119 | ``` |
| 120 | +## Requirements |
| 121 | + |
| 122 | +| Name | Version | |
| 123 | +|------|---------| |
| 124 | +| terraform | ~> 0.12.0 | |
| 125 | +| aws | ~> 2.0 | |
| 126 | +| local | ~> 1.2 | |
| 127 | +| null | ~> 2.0 | |
| 128 | + |
| 129 | +## Providers |
| 130 | + |
| 131 | +| Name | Version | |
| 132 | +|------|---------| |
| 133 | +| aws | ~> 2.0 | |
| 134 | + |
120 | 135 | ## Inputs |
121 | 136 |
|
122 | 137 | | Name | Description | Type | Default | Required | |
123 | | -|------|-------------|:----:|:-----:|:-----:| |
124 | | -| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no | |
125 | | -| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no | |
126 | | -| enabled | Set to false to prevent the module from creating any resources | bool | `true` | no | |
127 | | -| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no | |
128 | | -| force_destroy | Destroy even if it has non-Terraform-managed IAM access keys, login profiles or MFA devices | bool | `false` | no | |
129 | | -| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no | |
130 | | -| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no | |
131 | | -| path | Path in which to create the user | string | `/` | no | |
132 | | -| s3_actions | Actions to allow in the policy | list(string) | `<list>` | no | |
133 | | -| s3_resources | S3 resources to apply the actions specified in the policy | list(string) | - | yes | |
134 | | -| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no | |
135 | | -| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no | |
| 138 | +|------|-------------|------|---------|:--------:| |
| 139 | +| attributes | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no | |
| 140 | +| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | `string` | `"-"` | no | |
| 141 | +| enabled | Set to false to prevent the module from creating any resources | `bool` | `true` | no | |
| 142 | +| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | `string` | `""` | no | |
| 143 | +| force\_destroy | Destroy even if it has non-Terraform-managed IAM access keys, login profiles or MFA devices | `bool` | `false` | no | |
| 144 | +| name | Solution name, e.g. 'app' or 'jenkins' | `string` | `""` | no | |
| 145 | +| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | `string` | `""` | no | |
| 146 | +| path | Path in which to create the user | `string` | `"/"` | no | |
| 147 | +| s3\_actions | Actions to allow in the policy | `list(string)` | <pre>[<br> "s3:GetObject"<br>]</pre> | no | |
| 148 | +| s3\_resources | S3 resources to apply the actions specified in the policy | `list(string)` | n/a | yes | |
| 149 | +| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | `string` | `""` | no | |
| 150 | +| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no | |
136 | 151 |
|
137 | 152 | ## Outputs |
138 | 153 |
|
139 | 154 | | Name | Description | |
140 | 155 | |------|-------------| |
141 | | -| access_key_id | Access Key ID | |
142 | | -| secret_access_key | Secret Access Key. This will be written to the state file in plain-text | |
143 | | -| user_arn | The ARN assigned by AWS for the user | |
144 | | -| user_name | Normalized IAM user name | |
145 | | -| user_unique_id | The user unique ID assigned by AWS | |
| 156 | +| access\_key\_id | Access Key ID | |
| 157 | +| secret\_access\_key | Secret Access Key. This will be written to the state file in plain-text | |
| 158 | +| user\_arn | The ARN assigned by AWS for the user | |
| 159 | +| user\_name | Normalized IAM user name | |
| 160 | +| user\_unique\_id | The user unique ID assigned by AWS | |
146 | 161 |
|
147 | 162 |
|
148 | 163 |
|
@@ -200,6 +215,10 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our |
200 | 215 |
|
201 | 216 | Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure. |
202 | 217 |
|
| 218 | +## Discourse Forums |
| 219 | + |
| 220 | +Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account. |
| 221 | + |
203 | 222 | ## Newsletter |
204 | 223 |
|
205 | 224 | Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover. |
@@ -313,6 +332,7 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply |
313 | 332 | [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-s3-user&utm_content=testimonial |
314 | 333 | [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-s3-user&utm_content=office_hours |
315 | 334 | [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-s3-user&utm_content=newsletter |
| 335 | + [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-s3-user&utm_content=discourse |
316 | 336 | [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-s3-user&utm_content=email |
317 | 337 | [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-s3-user&utm_content=commercial_support |
318 | 338 | [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-iam-s3-user&utm_content=we_love_open_source |
|
0 commit comments