getKey

volcenginecc v0.0.24, Mar 9 26

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getKey

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyResult>

def get_key(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]

func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)
func LookupKeyOutput(ctx *Context, args *LookupKeyOutputArgs, opts ...InvokeOption) LookupKeyResultOutput

> Note: This function is named LookupKey in the Go SDK.

public static class GetKey 
{
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
public static Output<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:kms/getKey:getKey
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getKey Result

The following output properties are available:

CreatedTime int: 密钥创建时间。
Description string: 密钥描述:长度为 0 - 8192 个字符。
Id string: Uniquely identifies the resource.
KeyArchiveOperation int: 用户主密钥归档操作（用户输入1=归档，2=取消归档）
KeyEnableOperation int: 用户主密钥启用操作（用户输入1=启用，2=禁用）
KeyId string: 密钥唯一标识符，UUID形式。
KeyMaterialExpireTime string: 密钥材料过期时间，当值为空时表示不会过期。
KeyName string: 主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
KeyRotationOperation int: 用户主密钥轮转操作（用户输入1=开启，2=关闭）
KeySpec string: 对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
KeyState string: 密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
KeyUsage string: 密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
KeyringName string: 密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
LastRotationTime string: 密钥最后轮转时间。
MultiRegion bool: 是否为 Multi-region 类型的主密钥。
MultiRegionConfiguration Volcengine.GetKeyMultiRegionConfiguration: Multi-region key 配置信息。
Origin string: 密钥来源，取值：CloudKMS，External，ExternalKeyStore。
ProtectionLevel string: 密钥保护级别，取值：SOFTWARE，HSM。
RotateInterval int: 密钥轮转周期，单位：天；取值范围：[90, 2560]。
RotateState string: 密钥轮转状态，取值：Enable，Disable。
ScheduleDeleteTime string: 密钥删除时间。
ScheduleRotationTime string: 密钥轮转时间。
Tags List<Volcengine.GetKeyTag>: KMS密钥的标签信息
Trn string: 资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
UpdatedTime int: 密钥更新时间。

CreatedTime int: 密钥创建时间。
Description string: 密钥描述:长度为 0 - 8192 个字符。
Id string: Uniquely identifies the resource.
KeyArchiveOperation int: 用户主密钥归档操作（用户输入1=归档，2=取消归档）
KeyEnableOperation int: 用户主密钥启用操作（用户输入1=启用，2=禁用）
KeyId string: 密钥唯一标识符，UUID形式。
KeyMaterialExpireTime string: 密钥材料过期时间，当值为空时表示不会过期。
KeyName string: 主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
KeyRotationOperation int: 用户主密钥轮转操作（用户输入1=开启，2=关闭）
KeySpec string: 对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
KeyState string: 密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
KeyUsage string: 密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
KeyringName string: 密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
LastRotationTime string: 密钥最后轮转时间。
MultiRegion bool: 是否为 Multi-region 类型的主密钥。
MultiRegionConfiguration GetKeyMultiRegionConfiguration: Multi-region key 配置信息。
Origin string: 密钥来源，取值：CloudKMS，External，ExternalKeyStore。
ProtectionLevel string: 密钥保护级别，取值：SOFTWARE，HSM。
RotateInterval int: 密钥轮转周期，单位：天；取值范围：[90, 2560]。
RotateState string: 密钥轮转状态，取值：Enable，Disable。
ScheduleDeleteTime string: 密钥删除时间。
ScheduleRotationTime string: 密钥轮转时间。
Tags []GetKeyTag: KMS密钥的标签信息
Trn string: 资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
UpdatedTime int: 密钥更新时间。

createdTime Integer: 密钥创建时间。
description String: 密钥描述:长度为 0 - 8192 个字符。
id String: Uniquely identifies the resource.
keyArchiveOperation Integer: 用户主密钥归档操作（用户输入1=归档，2=取消归档）
keyEnableOperation Integer: 用户主密钥启用操作（用户输入1=启用，2=禁用）
keyId String: 密钥唯一标识符，UUID形式。
keyMaterialExpireTime String: 密钥材料过期时间，当值为空时表示不会过期。
keyName String: 主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
keyRotationOperation Integer: 用户主密钥轮转操作（用户输入1=开启，2=关闭）
keySpec String: 对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
keyState String: 密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
keyUsage String: 密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
keyringName String: 密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
lastRotationTime String: 密钥最后轮转时间。
multiRegion Boolean: 是否为 Multi-region 类型的主密钥。
multiRegionConfiguration GetKeyMultiRegionConfiguration: Multi-region key 配置信息。
origin String: 密钥来源，取值：CloudKMS，External，ExternalKeyStore。
protectionLevel String: 密钥保护级别，取值：SOFTWARE，HSM。
rotateInterval Integer: 密钥轮转周期，单位：天；取值范围：[90, 2560]。
rotateState String: 密钥轮转状态，取值：Enable，Disable。
scheduleDeleteTime String: 密钥删除时间。
scheduleRotationTime String: 密钥轮转时间。
tags List<GetKeyTag>: KMS密钥的标签信息
trn String: 资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
updatedTime Integer: 密钥更新时间。

createdTime number: 密钥创建时间。
description string: 密钥描述:长度为 0 - 8192 个字符。
id string: Uniquely identifies the resource.
keyArchiveOperation number: 用户主密钥归档操作（用户输入1=归档，2=取消归档）
keyEnableOperation number: 用户主密钥启用操作（用户输入1=启用，2=禁用）
keyId string: 密钥唯一标识符，UUID形式。
keyMaterialExpireTime string: 密钥材料过期时间，当值为空时表示不会过期。
keyName string: 主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
keyRotationOperation number: 用户主密钥轮转操作（用户输入1=开启，2=关闭）
keySpec string: 对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
keyState string: 密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
keyUsage string: 密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
keyringName string: 密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
lastRotationTime string: 密钥最后轮转时间。
multiRegion boolean: 是否为 Multi-region 类型的主密钥。
multiRegionConfiguration GetKeyMultiRegionConfiguration: Multi-region key 配置信息。
origin string: 密钥来源，取值：CloudKMS，External，ExternalKeyStore。
protectionLevel string: 密钥保护级别，取值：SOFTWARE，HSM。
rotateInterval number: 密钥轮转周期，单位：天；取值范围：[90, 2560]。
rotateState string: 密钥轮转状态，取值：Enable，Disable。
scheduleDeleteTime string: 密钥删除时间。
scheduleRotationTime string: 密钥轮转时间。
tags GetKeyTag[]: KMS密钥的标签信息
trn string: 资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
updatedTime number: 密钥更新时间。

created_time int: 密钥创建时间。
description str: 密钥描述:长度为 0 - 8192 个字符。
id str: Uniquely identifies the resource.
key_archive_operation int: 用户主密钥归档操作（用户输入1=归档，2=取消归档）
key_enable_operation int: 用户主密钥启用操作（用户输入1=启用，2=禁用）
key_id str: 密钥唯一标识符，UUID形式。
key_material_expire_time str: 密钥材料过期时间，当值为空时表示不会过期。
key_name str: 主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
key_rotation_operation int: 用户主密钥轮转操作（用户输入1=开启，2=关闭）
key_spec str: 对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
key_state str: 密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
key_usage str: 密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
keyring_name str: 密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
last_rotation_time str: 密钥最后轮转时间。
multi_region bool: 是否为 Multi-region 类型的主密钥。
multi_region_configuration GetKeyMultiRegionConfiguration: Multi-region key 配置信息。
origin str: 密钥来源，取值：CloudKMS，External，ExternalKeyStore。
protection_level str: 密钥保护级别，取值：SOFTWARE，HSM。
rotate_interval int: 密钥轮转周期，单位：天；取值范围：[90, 2560]。
rotate_state str: 密钥轮转状态，取值：Enable，Disable。
schedule_delete_time str: 密钥删除时间。
schedule_rotation_time str: 密钥轮转时间。
tags Sequence[GetKeyTag]: KMS密钥的标签信息
trn str: 资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
updated_time int: 密钥更新时间。

createdTime Number: 密钥创建时间。
description String: 密钥描述:长度为 0 - 8192 个字符。
id String: Uniquely identifies the resource.
keyArchiveOperation Number: 用户主密钥归档操作（用户输入1=归档，2=取消归档）
keyEnableOperation Number: 用户主密钥启用操作（用户输入1=启用，2=禁用）
keyId String: 密钥唯一标识符，UUID形式。
keyMaterialExpireTime String: 密钥材料过期时间，当值为空时表示不会过期。
keyName String: 主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
keyRotationOperation Number: 用户主密钥轮转操作（用户输入1=开启，2=关闭）
keySpec String: 对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
keyState String: 密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
keyUsage String: 密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
keyringName String: 密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
lastRotationTime String: 密钥最后轮转时间。
multiRegion Boolean: 是否为 Multi-region 类型的主密钥。
multiRegionConfiguration Property Map: Multi-region key 配置信息。
origin String: 密钥来源，取值：CloudKMS，External，ExternalKeyStore。
protectionLevel String: 密钥保护级别，取值：SOFTWARE，HSM。
rotateInterval Number: 密钥轮转周期，单位：天；取值范围：[90, 2560]。
rotateState String: 密钥轮转状态，取值：Enable，Disable。
scheduleDeleteTime String: 密钥删除时间。
scheduleRotationTime String: 密钥轮转时间。
tags List<Property Map>: KMS密钥的标签信息
trn String: 资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
updatedTime Number: 密钥更新时间。

Supporting Types

GetKeyMultiRegionConfiguration

MultiRegionKeyType string: 多区域密钥的类型。
PrimaryKey Volcengine.GetKeyMultiRegionConfigurationPrimaryKey: 主多区域键的事务识别号和区域 ID。
ReplicaKeys List<Volcengine.GetKeyMultiRegionConfigurationReplicaKey>: 副本多区域密钥的事务记录编号和区域 ID。

MultiRegionKeyType string: 多区域密钥的类型。
PrimaryKey GetKeyMultiRegionConfigurationPrimaryKey: 主多区域键的事务识别号和区域 ID。
ReplicaKeys []GetKeyMultiRegionConfigurationReplicaKey: 副本多区域密钥的事务记录编号和区域 ID。

multiRegionKeyType String: 多区域密钥的类型。
primaryKey GetKeyMultiRegionConfigurationPrimaryKey: 主多区域键的事务识别号和区域 ID。
replicaKeys List<GetKeyMultiRegionConfigurationReplicaKey>: 副本多区域密钥的事务记录编号和区域 ID。

multiRegionKeyType string: 多区域密钥的类型。
primaryKey GetKeyMultiRegionConfigurationPrimaryKey: 主多区域键的事务识别号和区域 ID。
replicaKeys GetKeyMultiRegionConfigurationReplicaKey[]: 副本多区域密钥的事务记录编号和区域 ID。

multi_region_key_type str: 多区域密钥的类型。
primary_key GetKeyMultiRegionConfigurationPrimaryKey: 主多区域键的事务识别号和区域 ID。
replica_keys Sequence[GetKeyMultiRegionConfigurationReplicaKey]: 副本多区域密钥的事务记录编号和区域 ID。

multiRegionKeyType String: 多区域密钥的类型。
primaryKey Property Map: 主多区域键的事务识别号和区域 ID。
replicaKeys List<Property Map>: 副本多区域密钥的事务记录编号和区域 ID。

GetKeyMultiRegionConfigurationPrimaryKey

Region string: 多区域密钥的区域 ID。
Trn string: 多区域密钥的 TRN。

Region string: 多区域密钥的区域 ID。
Trn string: 多区域密钥的 TRN。

region String: 多区域密钥的区域 ID。
trn String: 多区域密钥的 TRN。

region string: 多区域密钥的区域 ID。
trn string: 多区域密钥的 TRN。

region str: 多区域密钥的区域 ID。
trn str: 多区域密钥的 TRN。

region String: 多区域密钥的区域 ID。
trn String: 多区域密钥的 TRN。

GetKeyMultiRegionConfigurationReplicaKey

Region string: 多区域密钥的区域 ID。
Trn string: 多区域密钥的转换。

Region string: 多区域密钥的区域 ID。
Trn string: 多区域密钥的转换。

region String: 多区域密钥的区域 ID。
trn String: 多区域密钥的转换。

region string: 多区域密钥的区域 ID。
trn string: 多区域密钥的转换。

region str: 多区域密钥的区域 ID。
trn str: 多区域密钥的转换。

region String: 多区域密钥的区域 ID。
trn String: 多区域密钥的转换。

GetKeyTag

Key string: KMS密钥的标签键
Value string: KMS密钥的标签值

Key string: KMS密钥的标签键
Value string: KMS密钥的标签值

key String: KMS密钥的标签键
value String: KMS密钥的标签值

key string: KMS密钥的标签键
value string: KMS密钥的标签值

key str: KMS密钥的标签键
value str: KMS密钥的标签值

key String: KMS密钥的标签键
value String: KMS密钥的标签值

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.kms.getKey

On this page

On this page

Using getKey

getKey Result

Supporting Types

GetKeyMultiRegionConfiguration

GetKeyMultiRegionConfigurationPrimaryKey

GetKeyMultiRegionConfigurationReplicaKey

GetKeyTag

Package Details

On this page

On this page