volcenginecc.kms.Key

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Key Management Service (KMS) is a one-stop key management and data encryption platform on Volcano Engine. It provides easy-to-use encryption interfaces. KMS helps users easily manage keys and protect the security of core cloud data. It also greatly reduces the procurement and development costs for users to deploy their own cryptographic infrastructure. KMS helps businesses easily meet regulatory and compliance requirements.

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  kMSKeyDemo:
    type: volcenginecc:kms:Key
    name: KMSKeyDemo
    properties:
      keyringName: KMSKeyDemo
      keyName: KMSKeyDemoKeyName
      keySpec: SYMMETRIC_256
      description: description KMSKeyDemo
      keyUsage: ENCRYPT_DECRYPT
      protectionLevel: HSM
      rotateState: Enable
      origin: CloudKMS
      multiRegion: false
      rotateInterval: 900
      keyEnableOperation: 1
      keyRotationOperation: 1
      tags:
        - key: env
          value: test

Create Key Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Key(name: string, args: KeyArgs, opts?: CustomResourceOptions);

@overload
def Key(resource_name: str,
        args: KeyArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Key(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        key_name: Optional[str] = None,
        keyring_name: Optional[str] = None,
        key_usage: Optional[str] = None,
        key_enable_operation: Optional[int] = None,
        key_rotation_operation: Optional[int] = None,
        key_spec: Optional[str] = None,
        description: Optional[str] = None,
        key_archive_operation: Optional[int] = None,
        multi_region: Optional[bool] = None,
        origin: Optional[str] = None,
        protection_level: Optional[str] = None,
        rotate_interval: Optional[int] = None,
        tags: Optional[Sequence[KeyTagArgs]] = None)

func NewKey(ctx *Context, name string, args KeyArgs, opts ...ResourceOption) (*Key, error)

public Key(string name, KeyArgs args, CustomResourceOptions? opts = null)

public Key(String name, KeyArgs args)
public Key(String name, KeyArgs args, CustomResourceOptions options)

type: volcenginecc:kms:Key
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args KeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Key Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Key resource accepts the following input properties:

KeyName string: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
KeyringName string: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
Description string: Key description: Length 0–8192 characters.
KeyArchiveOperation int: User master key archive operation (enter 1 to archive, 2 to unarchive).
KeyEnableOperation int: User master key enable operation (enter 1 to enable, 2 to disable).
KeyRotationOperation int: User master key rotation operation (enter 1 to enable, 2 to disable).
KeySpec string: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
KeyUsage string: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
MultiRegion bool: Is this a multi-region type master key.
Origin string: Key source. Options: CloudKMS, External, ExternalKeyStore.
ProtectionLevel string: Key protection level. Options: SOFTWARE, HSM.
RotateInterval int: Key rotation period (days). Range: [90, 2560].
Tags List<Volcengine.KeyTag>

KeyName string: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
KeyringName string: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
Description string: Key description: Length 0–8192 characters.
KeyArchiveOperation int: User master key archive operation (enter 1 to archive, 2 to unarchive).
KeyEnableOperation int: User master key enable operation (enter 1 to enable, 2 to disable).
KeyRotationOperation int: User master key rotation operation (enter 1 to enable, 2 to disable).
KeySpec string: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
KeyUsage string: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
MultiRegion bool: Is this a multi-region type master key.
Origin string: Key source. Options: CloudKMS, External, ExternalKeyStore.
ProtectionLevel string: Key protection level. Options: SOFTWARE, HSM.
RotateInterval int: Key rotation period (days). Range: [90, 2560].
Tags []KeyTagArgs

keyName String: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
keyringName String: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
description String: Key description: Length 0–8192 characters.
keyArchiveOperation Integer: User master key archive operation (enter 1 to archive, 2 to unarchive).
keyEnableOperation Integer: User master key enable operation (enter 1 to enable, 2 to disable).
keyRotationOperation Integer: User master key rotation operation (enter 1 to enable, 2 to disable).
keySpec String: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
keyUsage String: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
multiRegion Boolean: Is this a multi-region type master key.
origin String: Key source. Options: CloudKMS, External, ExternalKeyStore.
protectionLevel String: Key protection level. Options: SOFTWARE, HSM.
rotateInterval Integer: Key rotation period (days). Range: [90, 2560].
tags List<KeyTag>

keyName string: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
keyringName string: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
description string: Key description: Length 0–8192 characters.
keyArchiveOperation number: User master key archive operation (enter 1 to archive, 2 to unarchive).
keyEnableOperation number: User master key enable operation (enter 1 to enable, 2 to disable).
keyRotationOperation number: User master key rotation operation (enter 1 to enable, 2 to disable).
keySpec string: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
keyUsage string: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
multiRegion boolean: Is this a multi-region type master key.
origin string: Key source. Options: CloudKMS, External, ExternalKeyStore.
protectionLevel string: Key protection level. Options: SOFTWARE, HSM.
rotateInterval number: Key rotation period (days). Range: [90, 2560].
tags KeyTag[]

key_name str: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
keyring_name str: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
description str: Key description: Length 0–8192 characters.
key_archive_operation int: User master key archive operation (enter 1 to archive, 2 to unarchive).
key_enable_operation int: User master key enable operation (enter 1 to enable, 2 to disable).
key_rotation_operation int: User master key rotation operation (enter 1 to enable, 2 to disable).
key_spec str: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
key_usage str: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
multi_region bool: Is this a multi-region type master key.
origin str: Key source. Options: CloudKMS, External, ExternalKeyStore.
protection_level str: Key protection level. Options: SOFTWARE, HSM.
rotate_interval int: Key rotation period (days). Range: [90, 2560].
tags Sequence[KeyTagArgs]

keyName String: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
keyringName String: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
description String: Key description: Length 0–8192 characters.
keyArchiveOperation Number: User master key archive operation (enter 1 to archive, 2 to unarchive).
keyEnableOperation Number: User master key enable operation (enter 1 to enable, 2 to disable).
keyRotationOperation Number: User master key rotation operation (enter 1 to enable, 2 to disable).
keySpec String: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
keyUsage String: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
multiRegion Boolean: Is this a multi-region type master key.
origin String: Key source. Options: CloudKMS, External, ExternalKeyStore.
protectionLevel String: Key protection level. Options: SOFTWARE, HSM.
rotateInterval Number: Key rotation period (days). Range: [90, 2560].
tags List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the Key resource produces the following output properties:

CreatedTime int: Key creation time.
Id string: The provider-assigned unique ID for this managed resource.
KeyId string: Key unique identifier in UUID format.
KeyMaterialExpireTime string: Key material expiration time. If empty, the key does not expire.
KeyStateValue string: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
LastRotationTime string: Key last rotation time.
MultiRegionConfiguration Volcengine.KeyMultiRegionConfiguration: Multi-region key configuration information.
RotateState string: Key rotation status. Options: Enable, Disable.
ScheduleDeleteTime string: Key deletion time.
ScheduleRotationTime string: Key rotation time.
Trn string: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
UpdatedTime int: Key update time.

CreatedTime int: Key creation time.
Id string: The provider-assigned unique ID for this managed resource.
KeyId string: Key unique identifier in UUID format.
KeyMaterialExpireTime string: Key material expiration time. If empty, the key does not expire.
KeyState string: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
LastRotationTime string: Key last rotation time.
MultiRegionConfiguration KeyMultiRegionConfiguration: Multi-region key configuration information.
RotateState string: Key rotation status. Options: Enable, Disable.
ScheduleDeleteTime string: Key deletion time.
ScheduleRotationTime string: Key rotation time.
Trn string: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
UpdatedTime int: Key update time.

createdTime Integer: Key creation time.
id String: The provider-assigned unique ID for this managed resource.
keyId String: Key unique identifier in UUID format.
keyMaterialExpireTime String: Key material expiration time. If empty, the key does not expire.
keyState String: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
lastRotationTime String: Key last rotation time.
multiRegionConfiguration KeyMultiRegionConfiguration: Multi-region key configuration information.
rotateState String: Key rotation status. Options: Enable, Disable.
scheduleDeleteTime String: Key deletion time.
scheduleRotationTime String: Key rotation time.
trn String: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
updatedTime Integer: Key update time.

createdTime number: Key creation time.
id string: The provider-assigned unique ID for this managed resource.
keyId string: Key unique identifier in UUID format.
keyMaterialExpireTime string: Key material expiration time. If empty, the key does not expire.
keyState string: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
lastRotationTime string: Key last rotation time.
multiRegionConfiguration KeyMultiRegionConfiguration: Multi-region key configuration information.
rotateState string: Key rotation status. Options: Enable, Disable.
scheduleDeleteTime string: Key deletion time.
scheduleRotationTime string: Key rotation time.
trn string: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
updatedTime number: Key update time.

created_time int: Key creation time.
id str: The provider-assigned unique ID for this managed resource.
key_id str: Key unique identifier in UUID format.
key_material_expire_time str: Key material expiration time. If empty, the key does not expire.
key_state str: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
last_rotation_time str: Key last rotation time.
multi_region_configuration KeyMultiRegionConfiguration: Multi-region key configuration information.
rotate_state str: Key rotation status. Options: Enable, Disable.
schedule_delete_time str: Key deletion time.
schedule_rotation_time str: Key rotation time.
trn str: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
updated_time int: Key update time.

createdTime Number: Key creation time.
id String: The provider-assigned unique ID for this managed resource.
keyId String: Key unique identifier in UUID format.
keyMaterialExpireTime String: Key material expiration time. If empty, the key does not expire.
keyState String: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
lastRotationTime String: Key last rotation time.
multiRegionConfiguration Property Map: Multi-region key configuration information.
rotateState String: Key rotation status. Options: Enable, Disable.
scheduleDeleteTime String: Key deletion time.
scheduleRotationTime String: Key rotation time.
trn String: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
updatedTime Number: Key update time.

Look up Existing Key Resource

Get an existing Key resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: KeyState, opts?: CustomResourceOptions): Key

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_time: Optional[int] = None,
        description: Optional[str] = None,
        key_archive_operation: Optional[int] = None,
        key_enable_operation: Optional[int] = None,
        key_id: Optional[str] = None,
        key_material_expire_time: Optional[str] = None,
        key_name: Optional[str] = None,
        key_rotation_operation: Optional[int] = None,
        key_spec: Optional[str] = None,
        key_state: Optional[str] = None,
        key_usage: Optional[str] = None,
        keyring_name: Optional[str] = None,
        last_rotation_time: Optional[str] = None,
        multi_region: Optional[bool] = None,
        multi_region_configuration: Optional[KeyMultiRegionConfigurationArgs] = None,
        origin: Optional[str] = None,
        protection_level: Optional[str] = None,
        rotate_interval: Optional[int] = None,
        rotate_state: Optional[str] = None,
        schedule_delete_time: Optional[str] = None,
        schedule_rotation_time: Optional[str] = None,
        tags: Optional[Sequence[KeyTagArgs]] = None,
        trn: Optional[str] = None,
        updated_time: Optional[int] = None) -> Key

func GetKey(ctx *Context, name string, id IDInput, state *KeyState, opts ...ResourceOption) (*Key, error)

public static Key Get(string name, Input<string> id, KeyState? state, CustomResourceOptions? opts = null)

public static Key get(String name, Output<String> id, KeyState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:kms:Key    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreatedTime int: Key creation time.
Description string: Key description: Length 0–8192 characters.
KeyArchiveOperation int: User master key archive operation (enter 1 to archive, 2 to unarchive).
KeyEnableOperation int: User master key enable operation (enter 1 to enable, 2 to disable).
KeyId string: Key unique identifier in UUID format.
KeyMaterialExpireTime string: Key material expiration time. If empty, the key does not expire.
KeyName string: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
KeyRotationOperation int: User master key rotation operation (enter 1 to enable, 2 to disable).
KeySpec string: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
KeyStateValue string: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
KeyUsage string: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
KeyringName string: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
LastRotationTime string: Key last rotation time.
MultiRegion bool: Is this a multi-region type master key.
MultiRegionConfiguration Volcengine.KeyMultiRegionConfiguration: Multi-region key configuration information.
Origin string: Key source. Options: CloudKMS, External, ExternalKeyStore.
ProtectionLevel string: Key protection level. Options: SOFTWARE, HSM.
RotateInterval int: Key rotation period (days). Range: [90, 2560].
RotateState string: Key rotation status. Options: Enable, Disable.
ScheduleDeleteTime string: Key deletion time.
ScheduleRotationTime string: Key rotation time.
Tags List<Volcengine.KeyTag>
Trn string: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
UpdatedTime int: Key update time.

CreatedTime int: Key creation time.
Description string: Key description: Length 0–8192 characters.
KeyArchiveOperation int: User master key archive operation (enter 1 to archive, 2 to unarchive).
KeyEnableOperation int: User master key enable operation (enter 1 to enable, 2 to disable).
KeyId string: Key unique identifier in UUID format.
KeyMaterialExpireTime string: Key material expiration time. If empty, the key does not expire.
KeyName string: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
KeyRotationOperation int: User master key rotation operation (enter 1 to enable, 2 to disable).
KeySpec string: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
KeyState string: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
KeyUsage string: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
KeyringName string: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
LastRotationTime string: Key last rotation time.
MultiRegion bool: Is this a multi-region type master key.
MultiRegionConfiguration KeyMultiRegionConfigurationArgs: Multi-region key configuration information.
Origin string: Key source. Options: CloudKMS, External, ExternalKeyStore.
ProtectionLevel string: Key protection level. Options: SOFTWARE, HSM.
RotateInterval int: Key rotation period (days). Range: [90, 2560].
RotateState string: Key rotation status. Options: Enable, Disable.
ScheduleDeleteTime string: Key deletion time.
ScheduleRotationTime string: Key rotation time.
Tags []KeyTagArgs
Trn string: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
UpdatedTime int: Key update time.

createdTime Integer: Key creation time.
description String: Key description: Length 0–8192 characters.
keyArchiveOperation Integer: User master key archive operation (enter 1 to archive, 2 to unarchive).
keyEnableOperation Integer: User master key enable operation (enter 1 to enable, 2 to disable).
keyId String: Key unique identifier in UUID format.
keyMaterialExpireTime String: Key material expiration time. If empty, the key does not expire.
keyName String: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
keyRotationOperation Integer: User master key rotation operation (enter 1 to enable, 2 to disable).
keySpec String: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
keyState String: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
keyUsage String: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
keyringName String: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
lastRotationTime String: Key last rotation time.
multiRegion Boolean: Is this a multi-region type master key.
multiRegionConfiguration KeyMultiRegionConfiguration: Multi-region key configuration information.
origin String: Key source. Options: CloudKMS, External, ExternalKeyStore.
protectionLevel String: Key protection level. Options: SOFTWARE, HSM.
rotateInterval Integer: Key rotation period (days). Range: [90, 2560].
rotateState String: Key rotation status. Options: Enable, Disable.
scheduleDeleteTime String: Key deletion time.
scheduleRotationTime String: Key rotation time.
tags List<KeyTag>
trn String: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
updatedTime Integer: Key update time.

createdTime number: Key creation time.
description string: Key description: Length 0–8192 characters.
keyArchiveOperation number: User master key archive operation (enter 1 to archive, 2 to unarchive).
keyEnableOperation number: User master key enable operation (enter 1 to enable, 2 to disable).
keyId string: Key unique identifier in UUID format.
keyMaterialExpireTime string: Key material expiration time. If empty, the key does not expire.
keyName string: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
keyRotationOperation number: User master key rotation operation (enter 1 to enable, 2 to disable).
keySpec string: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
keyState string: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
keyUsage string: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
keyringName string: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
lastRotationTime string: Key last rotation time.
multiRegion boolean: Is this a multi-region type master key.
multiRegionConfiguration KeyMultiRegionConfiguration: Multi-region key configuration information.
origin string: Key source. Options: CloudKMS, External, ExternalKeyStore.
protectionLevel string: Key protection level. Options: SOFTWARE, HSM.
rotateInterval number: Key rotation period (days). Range: [90, 2560].
rotateState string: Key rotation status. Options: Enable, Disable.
scheduleDeleteTime string: Key deletion time.
scheduleRotationTime string: Key rotation time.
tags KeyTag[]
trn string: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
updatedTime number: Key update time.

created_time int: Key creation time.
description str: Key description: Length 0–8192 characters.
key_archive_operation int: User master key archive operation (enter 1 to archive, 2 to unarchive).
key_enable_operation int: User master key enable operation (enter 1 to enable, 2 to disable).
key_id str: Key unique identifier in UUID format.
key_material_expire_time str: Key material expiration time. If empty, the key does not expire.
key_name str: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
key_rotation_operation int: User master key rotation operation (enter 1 to enable, 2 to disable).
key_spec str: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
key_state str: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
key_usage str: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
keyring_name str: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
last_rotation_time str: Key last rotation time.
multi_region bool: Is this a multi-region type master key.
multi_region_configuration KeyMultiRegionConfigurationArgs: Multi-region key configuration information.
origin str: Key source. Options: CloudKMS, External, ExternalKeyStore.
protection_level str: Key protection level. Options: SOFTWARE, HSM.
rotate_interval int: Key rotation period (days). Range: [90, 2560].
rotate_state str: Key rotation status. Options: Enable, Disable.
schedule_delete_time str: Key deletion time.
schedule_rotation_time str: Key rotation time.
tags Sequence[KeyTagArgs]
trn str: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
updated_time int: Key update time.

createdTime Number: Key creation time.
description String: Key description: Length 0–8192 characters.
keyArchiveOperation Number: User master key archive operation (enter 1 to archive, 2 to unarchive).
keyEnableOperation Number: User master key enable operation (enter 1 to enable, 2 to disable).
keyId String: Key unique identifier in UUID format.
keyMaterialExpireTime String: Key material expiration time. If empty, the key does not expire.
keyName String: Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
keyRotationOperation Number: User master key rotation operation (enter 1 to enable, 2 to disable).
keySpec String: Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
keyState String: Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
keyUsage String: Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
keyringName String: Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
lastRotationTime String: Key last rotation time.
multiRegion Boolean: Is this a multi-region type master key.
multiRegionConfiguration Property Map: Multi-region key configuration information.
origin String: Key source. Options: CloudKMS, External, ExternalKeyStore.
protectionLevel String: Key protection level. Options: SOFTWARE, HSM.
rotateInterval Number: Key rotation period (days). Range: [90, 2560].
rotateState String: Key rotation status. Options: Enable, Disable.
scheduleDeleteTime String: Key deletion time.
scheduleRotationTime String: Key rotation time.
tags List<Property Map>
trn String: Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
updatedTime Number: Key update time.

Supporting Types

KeyMultiRegionConfiguration, KeyMultiRegionConfigurationArgs

MultiRegionKeyType string: Multi-region key type.
PrimaryKey Volcengine.KeyMultiRegionConfigurationPrimaryKey: Primary multi-region key transaction identifier and region ID.
ReplicaKeys List<Volcengine.KeyMultiRegionConfigurationReplicaKey>

MultiRegionKeyType string: Multi-region key type.
PrimaryKey KeyMultiRegionConfigurationPrimaryKey: Primary multi-region key transaction identifier and region ID.
ReplicaKeys []KeyMultiRegionConfigurationReplicaKey

multiRegionKeyType String: Multi-region key type.
primaryKey KeyMultiRegionConfigurationPrimaryKey: Primary multi-region key transaction identifier and region ID.
replicaKeys List<KeyMultiRegionConfigurationReplicaKey>

multiRegionKeyType string: Multi-region key type.
primaryKey KeyMultiRegionConfigurationPrimaryKey: Primary multi-region key transaction identifier and region ID.
replicaKeys KeyMultiRegionConfigurationReplicaKey[]

multi_region_key_type str: Multi-region key type.
primary_key KeyMultiRegionConfigurationPrimaryKey: Primary multi-region key transaction identifier and region ID.
replica_keys Sequence[KeyMultiRegionConfigurationReplicaKey]

multiRegionKeyType String: Multi-region key type.
primaryKey Property Map: Primary multi-region key transaction identifier and region ID.
replicaKeys List<Property Map>

KeyMultiRegionConfigurationPrimaryKey, KeyMultiRegionConfigurationPrimaryKeyArgs

Region string: Multi-region key region ID.
Trn string: Multi-region key TRN.

Region string: Multi-region key region ID.
Trn string: Multi-region key TRN.

region String: Multi-region key region ID.
trn String: Multi-region key TRN.

region string: Multi-region key region ID.
trn string: Multi-region key TRN.

region str: Multi-region key region ID.
trn str: Multi-region key TRN.

region String: Multi-region key region ID.
trn String: Multi-region key TRN.

KeyMultiRegionConfigurationReplicaKey, KeyMultiRegionConfigurationReplicaKeyArgs

Region string: Multi-region key region ID.
Trn string: Multi-region key conversion.

Region string: Multi-region key region ID.
Trn string: Multi-region key conversion.

region String: Multi-region key region ID.
trn String: Multi-region key conversion.

region string: Multi-region key region ID.
trn string: Multi-region key conversion.

region str: Multi-region key region ID.
trn str: Multi-region key conversion.

region String: Multi-region key region ID.
trn String: Multi-region key conversion.

KeyTag, KeyTagArgs

Key string: KMS key label key.
Value string: KMS key label value.

Key string: KMS key label key.
Value string: KMS key label value.

key String: KMS key label key.
value String: KMS key label value.

key string: KMS key label key.
value string: KMS key label value.

key str: KMS key label key.
value str: KMS key label value.

key String: KMS key label key.
value String: KMS key label value.

Import

$ pulumi import volcenginecc:kms/key:Key example "keyring_name|key_id"

To learn more about importing existing cloud resources, see Importing resources.

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.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

On this page

On this page

Example Usage

Create Key Resource

Constructor syntax

Parameters

Key Resource Properties

Inputs

Outputs

Look up Existing Key Resource

Supporting Types

KeyMultiRegionConfiguration, KeyMultiRegionConfigurationArgs

KeyMultiRegionConfigurationPrimaryKey, KeyMultiRegionConfigurationPrimaryKeyArgs

KeyMultiRegionConfigurationReplicaKey, KeyMultiRegionConfigurationReplicaKeyArgs

KeyTag, KeyTagArgs

Import

Package Details

On this page

On this page