云应用 tencentcloud_kms_key

描述
腾讯云密钥管理系统（KMS），产品介绍。
用于创建和管理用户主密钥（CMK），支持对称加解密、非对称签名验证等多种密钥用途。
示例
resource "tencentcloud_kms_key" "main" {
  alias       = "my-kms-key"
  description = "my kms key"
  key_usage   = "ENCRYPT_DECRYPT"
  is_enabled  = true
﻿
  key_rotation_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：归档。
可选
key_usage
string
CMK 的用途。默认值为 ENCRYPT_DECRYPT。可选值包括：
ENCRYPT_DECRYPT：加密/解密。
ASYMMETRIC_DECRYPT_RSA_2048：RSA 2048 非对称解密。
ASYMMETRIC_DECRYPT_SM2：SM2 非对称解密。
ASYMMETRIC_SIGN_VERIFY_SM2：SM2 非对称签名验证。
ASYMMETRIC_SIGN_VERIFY_RSA_2048：RSA 2048 非对称签名验证。
ASYMMETRIC_SIGN_VERIFY_ECC：ECC 非对称签名验证。
可选
key_rotation_enabled
boolean
指定是否开启密钥轮转。仅当 key_usage 为 ENCRYPT_DECRYPT 时有效。默认值为 false。
可选
hsm_cluster_id
string
与 KMS 高级版对应的 HSM 集群 ID（仅对 KMS 专属版/托管版实例有效）。
可选
tags
Record<string, string>
CMK 的标签键值对。
生成
id
string
资源实例 ID。
生成
create_time
string
资源创建时间。

类型	名称	数据类型	说明
必填	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：归档。
	可选	key_usage	`string`	CMK 的用途。默认值为 ENCRYPT_DECRYPT。可选值包括： ENCRYPT_DECRYPT：加密/解密。 ASYMMETRIC_DECRYPT_RSA_2048：RSA 2048 非对称解密。 ASYMMETRIC_DECRYPT_SM2：SM2 非对称解密。 ASYMMETRIC_SIGN_VERIFY_SM2：SM2 非对称签名验证。 ASYMMETRIC_SIGN_VERIFY_RSA_2048：RSA 2048 非对称签名验证。 ASYMMETRIC_SIGN_VERIFY_ECC：ECC 非对称签名验证。
	可选	key_rotation_enabled	`boolean`	指定是否开启密钥轮转。仅当 key_usage 为 ENCRYPT_DECRYPT 时有效。默认值为 false。
	可选	hsm_cluster_id	`string`	与 KMS 高级版对应的 HSM 集群 ID（仅对 KMS 专属版/托管版实例有效）。
	可选	tags	`Record<string, string>`	CMK 的标签键值对。
生成	id	`string`	资源实例 ID。
生成	生成	create_time	`string`	资源创建时间。

tencentcloud_kms_key

本页目录：

描述

示例

参数说明