You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/umotif-public/terraform-aws-kms/releases/latest)
2
2
3
3
# terraform-aws-kms
4
4
5
5
Terraform module to configure a KMS Customer Master Key (CMK) and its alias.
6
6
7
7
## Terraform versions
8
8
9
-
Terraform 0.12. Pin module version to `~> v1.0`. Submit pull-requests to `master` branch.
9
+
Terraform 0.12 and provider version < 3.53.0. Pin module version to `~> v1.0`.
10
+
For Terraform 0.12 with provider version >= 3.53.0. Pin module version to `~> v2.0`. Submit pull-requests to `main` branch.
10
11
11
12
## Usage
12
13
13
14
```hcl
14
15
module "kms" {
15
16
source = "umotif-public/kms/aws"
16
-
version = "~> 1.0.0"
17
+
version = "~> 2.0.0"
17
18
18
19
enabled = true
19
20
description = "KMS test description"
@@ -33,50 +34,63 @@ Module is to be used with Terraform > 0.12.
| alias\_name | The display name of the alias. |`string`| n/a | yes |
61
-
| customer\_master\_key\_spec | Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: SYMMETRIC\_DEFAULT, RSA\_2048, RSA\_3072, RSA\_4096, ECC\_NIST\_P256, ECC\_NIST\_P384, ECC\_NIST\_P521, or ECC\_SECG\_P256K1. Defaults to SYMMETRIC\_DEFAULT. |`string`|`"SYMMETRIC_DEFAULT"`| no |
62
-
| deletion\_window\_in\_days | Duration in days after which the key is deleted after destruction of the resource. |`number`|`10`| no |
63
-
| description | The description of the key as viewed in AWS console. |`string`|`"Parameter Store KMS master key"`| no |
64
-
| enable\_key\_rotation | Specifies whether key rotation is enabled. |`bool`|`true`| no |
65
-
| enabled | Specifies whether to create resources within this module. |`bool`|`true`| no |
66
-
| is\_enabled | Specifies whether the key is enabled. |`bool`|`true`| no |
67
-
| key\_usage | Specifies the intended use of the key. Defaults to ENCRYPT\_DECRYPT, and only symmetric encryption and decryption are supported. |`string`|`"ENCRYPT_DECRYPT"`| no |
68
-
| policy | A valid policy JSON document. For more information about building AWS IAM policy documents with Terraform. |`string`|`""`| no |
69
-
| tags | Mapping of additional tags. |`map(string)`|`{}`| no |
74
+
| <aname="input_alias_name"></a> [alias\_name](#input\_alias\_name)| The display name of the alias. |`string`| n/a | yes |
75
+
| <aname="input_bypass_policy_lockout_safety_check"></a> [bypass\_policy\_lockout\_safety\_check](#input\_bypass\_policy\_lockout\_safety\_check)| Specifies whether to disable the policy lockout check performed when creating or updating the key's policy. |`bool`|`false`| no |
76
+
| <aname="input_customer_master_key_spec"></a> [customer\_master\_key\_spec](#input\_customer\_master\_key\_spec)| Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: SYMMETRIC\_DEFAULT, RSA\_2048, RSA\_3072, RSA\_4096, ECC\_NIST\_P256, ECC\_NIST\_P384, ECC\_NIST\_P521, or ECC\_SECG\_P256K1. Defaults to SYMMETRIC\_DEFAULT. |`string`|`"SYMMETRIC_DEFAULT"`| no |
77
+
| <aname="input_deletion_window_in_days"></a> [deletion\_window\_in\_days](#input\_deletion\_window\_in\_days)| Duration in days after which the key is deleted after destruction of the resource. |`number`|`10`| no |
78
+
| <aname="input_description"></a> [description](#input\_description)| The description of the key as viewed in AWS console. |`string`|`"Parameter Store KMS master key"`| no |
79
+
| <aname="input_enable_key_rotation"></a> [enable\_key\_rotation](#input\_enable\_key\_rotation)| Specifies whether key rotation is enabled. |`bool`|`true`| no |
80
+
| <aname="input_enabled"></a> [enabled](#input\_enabled)| Specifies whether to create resources within this module. |`bool`|`true`| no |
81
+
| <aname="input_is_enabled"></a> [is\_enabled](#input\_is\_enabled)| Specifies whether the key is enabled. |`bool`|`true`| no |
82
+
| <aname="input_key_usage"></a> [key\_usage](#input\_key\_usage)| Specifies the intended use of the key. Defaults to ENCRYPT\_DECRYPT, and only symmetric encryption and decryption are supported. |`string`|`"ENCRYPT_DECRYPT"`| no |
83
+
| <aname="input_policy"></a> [policy](#input\_policy)| A valid policy JSON document. For more information about building AWS IAM policy documents with Terraform. |`string`|`""`| no |
84
+
| <aname="input_tags"></a> [tags](#input\_tags)| Mapping of additional tags. |`map(string)`|`{}`| no |
70
85
71
86
## Outputs
72
87
73
88
| Name | Description |
74
89
|------|-------------|
75
-
| alias\_arn | KMS Key Alias ARN. |
76
-
| alias\_name | KMS Key Alias name. |
77
-
| key\_arn | KMS Key ARN. |
78
-
| key\_id | KMS Key ID. |
79
-
90
+
| <aname="output_alias_arn"></a> [alias\_arn](#output\_alias\_arn)| KMS Key Alias ARN. |
91
+
| <aname="output_alias_name"></a> [alias\_name](#output\_alias\_name)| KMS Key Alias name. |
0 commit comments