|
42 | 42 |
|
43 | 43 | [![Cloud Posse][logo]](https://cpco.io/homepage)
|
44 | 44 |
|
45 |
| -# terraform-aws-kms-key [](https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d163820e38a0455f412f79f) [](https://github.com/cloudposse/terraform-aws-kms-key/releases/latest) [](https://slack.cloudposse.com) |
| 45 | +# terraform-aws-kms-key [](https://github.com/cloudposse/terraform-aws-kms-key/releases/latest) [](https://slack.cloudposse.com) |
46 | 46 |
|
47 | 47 |
|
48 | 48 | Terraform module to provision a [KMS](https://aws.amazon.com/kms/) key with alias.
|
@@ -119,32 +119,47 @@ Available targets:
|
119 | 119 | lint Lint terraform code
|
120 | 120 |
|
121 | 121 | ```
|
| 122 | +## Requirements |
| 123 | + |
| 124 | +| Name | Version | |
| 125 | +|------|---------| |
| 126 | +| terraform | ~> 0.12.0 | |
| 127 | +| aws | ~> 2.0 | |
| 128 | +| local | ~> 1.2 | |
| 129 | +| null | ~> 2.0 | |
| 130 | + |
| 131 | +## Providers |
| 132 | + |
| 133 | +| Name | Version | |
| 134 | +|------|---------| |
| 135 | +| aws | ~> 2.0 | |
| 136 | + |
122 | 137 | ## Inputs
|
123 | 138 |
|
124 | 139 | | Name | Description | Type | Default | Required |
|
125 |
| -|------|-------------|:----:|:-----:|:-----:| |
126 |
| -| alias | The display name of the alias. The name must start with the word `alias` followed by a forward slash | string | `` | no | |
127 |
| -| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no | |
128 |
| -| deletion_window_in_days | Duration in days after which the key is deleted after destruction of the resource | number | `10` | no | |
129 |
| -| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no | |
130 |
| -| description | The description of the key as viewed in AWS console | string | `Parameter Store KMS master key` | no | |
131 |
| -| enable_key_rotation | Specifies whether key rotation is enabled | bool | `true` | no | |
132 |
| -| enabled | Set to false to prevent the module from creating any resources | bool | `true` | no | |
133 |
| -| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no | |
134 |
| -| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no | |
135 |
| -| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no | |
136 |
| -| policy | A valid KMS policy JSON document. Note that if the policy document is not specific enough (but still valid), Terraform may view the policy as constantly changing in a terraform plan. In this case, please make sure you use the verbose/specific version of the policy. | string | `` | no | |
137 |
| -| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no | |
138 |
| -| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no | |
| 140 | +|------|-------------|------|---------|:--------:| |
| 141 | +| alias | The display name of the alias. The name must start with the word `alias` followed by a forward slash | `string` | `""` | no | |
| 142 | +| attributes | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no | |
| 143 | +| deletion\_window\_in\_days | Duration in days after which the key is deleted after destruction of the resource | `number` | `10` | no | |
| 144 | +| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | `string` | `"-"` | no | |
| 145 | +| description | The description of the key as viewed in AWS console | `string` | `"Parameter Store KMS master key"` | no | |
| 146 | +| enable\_key\_rotation | Specifies whether key rotation is enabled | `bool` | `true` | no | |
| 147 | +| enabled | Set to false to prevent the module from creating any resources | `bool` | `true` | no | |
| 148 | +| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | `string` | `""` | no | |
| 149 | +| name | Solution name, e.g. 'app' or 'jenkins' | `string` | `""` | no | |
| 150 | +| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | `string` | `""` | no | |
| 151 | +| policy | A valid KMS policy JSON document. Note that if the policy document is not specific enough (but still valid), Terraform may view the policy as constantly changing in a terraform plan. In this case, please make sure you use the verbose/specific version of the policy. | `string` | `""` | no | |
| 152 | +| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | `string` | `""` | no | |
| 153 | +| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no | |
139 | 154 |
|
140 | 155 | ## Outputs
|
141 | 156 |
|
142 | 157 | | Name | Description |
|
143 | 158 | |------|-------------|
|
144 |
| -| alias_arn | Alias ARN | |
145 |
| -| alias_name | Alias name | |
146 |
| -| key_arn | Key ARN | |
147 |
| -| key_id | Key ID | |
| 159 | +| alias\_arn | Alias ARN | |
| 160 | +| alias\_name | Alias name | |
| 161 | +| key\_arn | Key ARN | |
| 162 | +| key\_id | Key ID | |
148 | 163 |
|
149 | 164 |
|
150 | 165 |
|
@@ -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-kms-key&utm_content=testimonial
|
314 | 333 | [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-kms-key&utm_content=office_hours
|
315 | 334 | [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-kms-key&utm_content=newsletter
|
| 335 | + [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-kms-key&utm_content=discourse |
316 | 336 | [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-kms-key&utm_content=email
|
317 | 337 | [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-kms-key&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-kms-key&utm_content=we_love_open_source
|
|
0 commit comments