一、示例
resource "tencentcloud_kms_external_key" "main" { alias = "my-external-kms-key" description = "external kms key with custom material" wrapping_algorithm = "RSAES_PKCS1_V1_5" key_material_base64 = var.key_material_base64 valid_to = 0 is_enabled = true tags = { env = "prod" }}
二、参数说明
| 类型 | 名称 | 数据类型 | 说明 |
| 必填 | region | string | 地域,如:ap-guangzhou,默认使用 provider 中定义的 region,也可以在 resource 中指定地域,覆盖默认设置。 |
| 必填 | alias | string | CMK 的别名。名称只能包含英文、数字、下划线 _ 和连字符 -。首字符必须为字母或数字。 |
| 可选 | availability_zone | string | 可用区。 |
| 可选 | count | int | 资源数量,默认为 1。如果为 0 则不创建资源。 |
| 可选 | activity_id | int | 计费活动 ID,保留字段。 |
| 可选 | description | string | CMK 的描述信息。最大长度为 1024 字节。 |
| 可选 | is_enabled | boolean | 指定是否启用密钥。默认值为 false。该字段与 is_archived 冲突,仅在密钥状态为 Enabled、Disabled 或 Archived 时有效。 |
| 可选 | is_archived | boolean | 指定是否归档密钥。默认值为 false。该字段与 is_enabled 冲突,仅在密钥状态为 Enabled(已启用)、Disabled(已禁用)或 Archived(已归档)时有效。 |
| 可选 | pending_delete_window_in_days | int | 删除窗口天数。 |
| 可选 | key_state | string | CMK 的状态。默认值为 Enabled。可选值包括:Enabled:启用。Disabled:禁用。Archived:归档。 |
| 可选 | wrapping_algorithm | KmsWrapperAlgorithm | 加密密钥材料的算法。可选值包括 RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1 和 RSAES_OAEP_SHA_256。默认值为 RSAES_PKCS1_V1_5。 |
| 可选 | key_material_base64 | string | 经由公钥(public_key)加密并进行 Base64 编码的密钥材料。对于使用国密版本的地域,导入的密钥材料长度需为 128 位;对于使用 FIPS 版本的地域,长度需为 256 位。 |
| 可选 | valid_to | int | 表示密钥材料的有效时间戳,0表示永不过期。该值必须大于当前时间戳,最大支持 2147443200。 |
| 可选 | hsm_cluster_id | string | 与 KMS 高级版对应的 HSM 集群 ID(仅适用于 KMS 专属版/托管版服务实例)。 |
| 可选 | tags | Record<string, string> | CMK 的标签键值对。 |
| 生成 | id | string | 资源实例 ID。 |
| 生成 | create_time | string | 资源创建时间。 |