alicloud_kms_key

Provides a KMS Key resource.

For information about KMS Key and how to use it, see What is Key.

-> NOTE: Available since v1.85.0.

Example Usage

Basic Usage

resource "alicloud_kms_key" "default" {
  description            = "Hello KMS"
  status                 = "Enabled"
  pending_window_in_days = "7"
}

Argument Reference

The following arguments are supported:

• key_usage - (Optional, ForceNew) The usage of the key. Default value: ENCRYPT/DECRYPT. Valid values:
  • ENCRYPT/DECRYPT: Encrypts or decrypts data.
  • SIGN/VERIFY: Generates or verifies a digital signature.
• origin - (Optional, ForceNew) The key material origin. Default value: Aliyun_KMS. Valid values: Aliyun_KMS, EXTERNAL.
• key_spec - (Optional, ForceNew) The specification of the key. Default value: Aliyun_AES_256. Valid values: Aliyun_AES_256, Aliyun_AES_128, Aliyun_AES_192, Aliyun_SM4, RSA_2048, RSA_3072, EC_P256, EC_P256K, EC_SM2.
• dkms_instance_id - (Optional, ForceNew, Available since v1.183.0) The ID of the KMS instance.
• protection_level - (Optional, ForceNew) The protection level of the key. Default value: SOFTWARE. Valid values: SOFTWARE, HSM.
• automatic_rotation - (Optional) Specifies whether to enable automatic key rotation. Default value: Disabled. Valid values: Enabled, Disabled.
• rotation_interval - (Optional) The period of automatic key rotation. The following units are supported: d (day), h (hour), m (minute), and s (second). For example, you can use either 7d or 604800s to specify a seven-day interval. NOTE: If automatic_rotation is set to Enabled, rotation_interval is required.
• policy - (Optional, Available since v1.224.0) The content of the key policy. The value is in the JSON format. The value can be up to 32,768 bytes in length. For more information, see How to use it.
• description - (Optional) The description of the key.
• status - (Optional, Available since v1.123.1) The status of key. Default value: Enabled. Valid values: Enabled, Disabled, PendingDeletion.
• pending_window_in_days - (Optional, Int) The number of days before the CMK is deleted. During this period, the CMK is in the PendingDeletion state. After this period ends, you cannot cancel the deletion. Unit: days. Valid values: 7 to 366. NOTE: From version 1.184.0, pending_window_in_days can be set to 366.
• tags - (Optional, Available since v1.207.0) A mapping of tags to assign to the resource.
• deletion_window_in_days - (Optional, Int, Deprecated since v1.85.0) Field deletion_window_in_days has been deprecated from provider version 1.85.0. New field pending_window_in_days instead.
• key_state - (Deprecated since v1.123.1) Field key_state has been deprecated from provider version 1.123.1. New field status instead.
• is_enabled - (Optional, Bool, Deprecated since v1.85.0) Field is_enabled has been deprecated from provider version 1.85.0. New field status instead.

-> NOTE: If you set the origin parameter to EXTERNAL or the key_spec parameter to an asymmetric CMK type, automatic key rotation is unavailable.

-> NOTE: The default type of the CMK is Aliyun_AES_256. Only Dedicated KMS supports Aliyun_AES_128 and Aliyun_AES_192.

-> NOTE: When the pre-deletion days elapses, the key is permanently deleted and cannot be recovered.

Attributes Reference

• id - The resource ID in terraform of Key.
• arn - The ARN of the key.
• primary_key_version - The ID of the current primary key version of the symmetric CMK.
• last_rotation_date - The time when the last rotation was performed.
• next_rotation_date - The time when the next rotation will be performed.
• material_expire_time - The time when the key material expires.
• creator - The creator of the CMK.
• creation_date - The time when the CMK was created.
• delete_date - The time at which the CMK is scheduled for deletion.

Timeouts

-> NOTE: Available since v1.224.0.

The timeouts block allows you to specify timeouts for certain actions:

• create - (Defaults to 5 mins) Used when create the Key.
• update - (Defaults to 5 mins) Used when update the Key.
• delete - (Defaults to 5 mins) Used when delete the Key.

Import

KMS Key can be imported using the id, e.g.

$ terraform import alicloud_kms_key.example <id>