Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kms
  6. getKey
Viewing docs for volcenginecc v0.0.39
published on Monday, Jun 1, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kms.getKey

volcenginecc logo
Viewing docs for volcenginecc v0.0.39
published on Monday, Jun 1, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::KMS::Key

    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: pulumi.Input[Optional[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
    data "volcenginecc_kms_getkey" "name" {
    # arguments
}

    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 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:

    AsymmetricCiphertext Volcengine.GetKeyAsymmetricCiphertext
    Asymmetric encryption action parameters and results. AsymmetricEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    AsymmetricSignature Volcengine.GetKeyAsymmetricSignature
    Asymmetric signature action parameters and results. AsymmetricSign can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    Ciphertext Volcengine.GetKeyCiphertext
    Symmetric encryption action parameters and results. Encrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    CreatedTime int
    Key creation time.
    Description string
    Key description: Length 0–8192 characters.
    Id string
    Uniquely identifies the resource.
    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-_].
    KeyPrimaryRegion string
    Primary region of the multi-region key. Set the target primary region during the Create/Update phase; the current primary region is returned during the Read phase.
    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 Volcengine.GetKeyMultiRegionConfiguration
    Multi-region key configuration information.
    Origin string
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    ProtectionLevel string
    Key protection level. Options: SOFTWARE, HSM.
    ReEncrypt Volcengine.GetKeyReEncrypt
    Re-encryption action parameters and results. ReEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    ReplicateKey Volcengine.GetKeyReplicateKey
    Replicate key action parameters and results. ReplicateKey can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    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.GetKeyTag>
    KMS key label information.
    Trn string
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    UpdatedTime int
    Key update time.
    AsymmetricCiphertext GetKeyAsymmetricCiphertext
    Asymmetric encryption action parameters and results. AsymmetricEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    AsymmetricSignature GetKeyAsymmetricSignature
    Asymmetric signature action parameters and results. AsymmetricSign can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    Ciphertext GetKeyCiphertext
    Symmetric encryption action parameters and results. Encrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    CreatedTime int
    Key creation time.
    Description string
    Key description: Length 0–8192 characters.
    Id string
    Uniquely identifies the resource.
    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-_].
    KeyPrimaryRegion string
    Primary region of the multi-region key. Set the target primary region during the Create/Update phase; the current primary region is returned during the Read phase.
    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 GetKeyMultiRegionConfiguration
    Multi-region key configuration information.
    Origin string
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    ProtectionLevel string
    Key protection level. Options: SOFTWARE, HSM.
    ReEncrypt GetKeyReEncrypt
    Re-encryption action parameters and results. ReEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    ReplicateKey GetKeyReplicateKey
    Replicate key action parameters and results. ReplicateKey can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    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 []GetKeyTag
    KMS key label information.
    Trn string
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    UpdatedTime int
    Key update time.
    asymmetric_ciphertext object
    Asymmetric encryption action parameters and results. AsymmetricEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    asymmetric_signature object
    Asymmetric signature action parameters and results. AsymmetricSign can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    ciphertext object
    Symmetric encryption action parameters and results. Encrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    created_time number
    Key creation time.
    description string
    Key description: Length 0–8192 characters.
    id string
    Uniquely identifies the resource.
    key_archive_operation number
    User master key archive operation (enter 1 to archive, 2 to unarchive).
    key_enable_operation number
    User master key enable operation (enter 1 to enable, 2 to disable).
    key_id string
    Key unique identifier in UUID format.
    key_material_expire_time string
    Key material expiration time. If empty, the key does not expire.
    key_name string
    Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
    key_primary_region string
    Primary region of the multi-region key. Set the target primary region during the Create/Update phase; the current primary region is returned during the Read phase.
    key_rotation_operation number
    User master key rotation operation (enter 1 to enable, 2 to disable).
    key_spec string
    Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
    key_state string
    Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
    key_usage string
    Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
    keyring_name string
    Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
    last_rotation_time string
    Key last rotation time.
    multi_region bool
    Is this a multi-region type master key.
    multi_region_configuration object
    Multi-region key configuration information.
    origin string
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    protection_level string
    Key protection level. Options: SOFTWARE, HSM.
    re_encrypt object
    Re-encryption action parameters and results. ReEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    replicate_key object
    Replicate key action parameters and results. ReplicateKey can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    rotate_interval number
    Key rotation period (days). Range: [90, 2560].
    rotate_state string
    Key rotation status. Options: Enable, Disable.
    schedule_delete_time string
    Key deletion time.
    schedule_rotation_time string
    Key rotation time.
    tags list(object)
    KMS key label information.
    trn string
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updated_time number
    Key update time.
    asymmetricCiphertext GetKeyAsymmetricCiphertext
    Asymmetric encryption action parameters and results. AsymmetricEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    asymmetricSignature GetKeyAsymmetricSignature
    Asymmetric signature action parameters and results. AsymmetricSign can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    ciphertext GetKeyCiphertext
    Symmetric encryption action parameters and results. Encrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    createdTime Integer
    Key creation time.
    description String
    Key description: Length 0–8192 characters.
    id String
    Uniquely identifies the resource.
    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-_].
    keyPrimaryRegion String
    Primary region of the multi-region key. Set the target primary region during the Create/Update phase; the current primary region is returned during the Read phase.
    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 GetKeyMultiRegionConfiguration
    Multi-region key configuration information.
    origin String
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    protectionLevel String
    Key protection level. Options: SOFTWARE, HSM.
    reEncrypt GetKeyReEncrypt
    Re-encryption action parameters and results. ReEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    replicateKey GetKeyReplicateKey
    Replicate key action parameters and results. ReplicateKey can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    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<GetKeyTag>
    KMS key label information.
    trn String
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updatedTime Integer
    Key update time.
    asymmetricCiphertext GetKeyAsymmetricCiphertext
    Asymmetric encryption action parameters and results. AsymmetricEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    asymmetricSignature GetKeyAsymmetricSignature
    Asymmetric signature action parameters and results. AsymmetricSign can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    ciphertext GetKeyCiphertext
    Symmetric encryption action parameters and results. Encrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    createdTime number
    Key creation time.
    description string
    Key description: Length 0–8192 characters.
    id string
    Uniquely identifies the resource.
    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-_].
    keyPrimaryRegion string
    Primary region of the multi-region key. Set the target primary region during the Create/Update phase; the current primary region is returned during the Read phase.
    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 GetKeyMultiRegionConfiguration
    Multi-region key configuration information.
    origin string
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    protectionLevel string
    Key protection level. Options: SOFTWARE, HSM.
    reEncrypt GetKeyReEncrypt
    Re-encryption action parameters and results. ReEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    replicateKey GetKeyReplicateKey
    Replicate key action parameters and results. ReplicateKey can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    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 GetKeyTag[]
    KMS key label information.
    trn string
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updatedTime number
    Key update time.
    asymmetric_ciphertext GetKeyAsymmetricCiphertext
    Asymmetric encryption action parameters and results. AsymmetricEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    asymmetric_signature GetKeyAsymmetricSignature
    Asymmetric signature action parameters and results. AsymmetricSign can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    ciphertext GetKeyCiphertext
    Symmetric encryption action parameters and results. Encrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    created_time int
    Key creation time.
    description str
    Key description: Length 0–8192 characters.
    id str
    Uniquely identifies the resource.
    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_primary_region str
    Primary region of the multi-region key. Set the target primary region during the Create/Update phase; the current primary region is returned during the Read phase.
    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 GetKeyMultiRegionConfiguration
    Multi-region key configuration information.
    origin str
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    protection_level str
    Key protection level. Options: SOFTWARE, HSM.
    re_encrypt GetKeyReEncrypt
    Re-encryption action parameters and results. ReEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    replicate_key GetKeyReplicateKey
    Replicate key action parameters and results. ReplicateKey can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    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[GetKeyTag]
    KMS key label information.
    trn str
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updated_time int
    Key update time.
    asymmetricCiphertext Property Map
    Asymmetric encryption action parameters and results. AsymmetricEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    asymmetricSignature Property Map
    Asymmetric signature action parameters and results. AsymmetricSign can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    ciphertext Property Map
    Symmetric encryption action parameters and results. Encrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    createdTime Number
    Key creation time.
    description String
    Key description: Length 0–8192 characters.
    id String
    Uniquely identifies the resource.
    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-_].
    keyPrimaryRegion String
    Primary region of the multi-region key. Set the target primary region during the Create/Update phase; the current primary region is returned during the Read phase.
    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.
    reEncrypt Property Map
    Re-encryption action parameters and results. ReEncrypt can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    replicateKey Property Map
    Replicate key action parameters and results. ReplicateKey can be triggered during the Create/Update phase; the result is only guaranteed to be returned in the current response.
    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>
    KMS key label information.
    trn String
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updatedTime Number
    Key update time.

    Supporting Types

    GetKeyAsymmetricCiphertext

    Algorithm string
    Encryption algorithm. Optional values: RSAESOAEPSHA_256, SM2PKE.
    CiphertextBlob string
    Ciphertext of encryption result, Base64-encoded.
    Plaintext string
    Plaintext to be encrypted, Base64-encoded.
    Algorithm string
    Encryption algorithm. Optional values: RSAESOAEPSHA_256, SM2PKE.
    CiphertextBlob string
    Ciphertext of encryption result, Base64-encoded.
    Plaintext string
    Plaintext to be encrypted, Base64-encoded.
    algorithm string
    Encryption algorithm. Optional values: RSAESOAEPSHA_256, SM2PKE.
    ciphertext_blob string
    Ciphertext of encryption result, Base64-encoded.
    plaintext string
    Plaintext to be encrypted, Base64-encoded.
    algorithm String
    Encryption algorithm. Optional values: RSAESOAEPSHA_256, SM2PKE.
    ciphertextBlob String
    Ciphertext of encryption result, Base64-encoded.
    plaintext String
    Plaintext to be encrypted, Base64-encoded.
    algorithm string
    Encryption algorithm. Optional values: RSAESOAEPSHA_256, SM2PKE.
    ciphertextBlob string
    Ciphertext of encryption result, Base64-encoded.
    plaintext string
    Plaintext to be encrypted, Base64-encoded.
    algorithm str
    Encryption algorithm. Optional values: RSAESOAEPSHA_256, SM2PKE.
    ciphertext_blob str
    Ciphertext of encryption result, Base64-encoded.
    plaintext str
    Plaintext to be encrypted, Base64-encoded.
    algorithm String
    Encryption algorithm. Optional values: RSAESOAEPSHA_256, SM2PKE.
    ciphertextBlob String
    Ciphertext of encryption result, Base64-encoded.
    plaintext String
    Plaintext to be encrypted, Base64-encoded.

    GetKeyAsymmetricSignature

    Algorithm string
    Signature algorithm, for example: RSAPSSSHA256, RSAPKCS1SHA256, ECDSASHA256, SM2_DSA.
    Message string
    Message to be signed, Base64-encoded.
    MessageType string
    Message type. Optional values: RAW, DIGEST.
    Signature string
    Signature result, Base64-encoded.
    Algorithm string
    Signature algorithm, for example: RSAPSSSHA256, RSAPKCS1SHA256, ECDSASHA256, SM2_DSA.
    Message string
    Message to be signed, Base64-encoded.
    MessageType string
    Message type. Optional values: RAW, DIGEST.
    Signature string
    Signature result, Base64-encoded.
    algorithm string
    Signature algorithm, for example: RSAPSSSHA256, RSAPKCS1SHA256, ECDSASHA256, SM2_DSA.
    message string
    Message to be signed, Base64-encoded.
    message_type string
    Message type. Optional values: RAW, DIGEST.
    signature string
    Signature result, Base64-encoded.
    algorithm String
    Signature algorithm, for example: RSAPSSSHA256, RSAPKCS1SHA256, ECDSASHA256, SM2_DSA.
    message String
    Message to be signed, Base64-encoded.
    messageType String
    Message type. Optional values: RAW, DIGEST.
    signature String
    Signature result, Base64-encoded.
    algorithm string
    Signature algorithm, for example: RSAPSSSHA256, RSAPKCS1SHA256, ECDSASHA256, SM2_DSA.
    message string
    Message to be signed, Base64-encoded.
    messageType string
    Message type. Optional values: RAW, DIGEST.
    signature string
    Signature result, Base64-encoded.
    algorithm str
    Signature algorithm, for example: RSAPSSSHA256, RSAPKCS1SHA256, ECDSASHA256, SM2_DSA.
    message str
    Message to be signed, Base64-encoded.
    message_type str
    Message type. Optional values: RAW, DIGEST.
    signature str
    Signature result, Base64-encoded.
    algorithm String
    Signature algorithm, for example: RSAPSSSHA256, RSAPKCS1SHA256, ECDSASHA256, SM2_DSA.
    message String
    Message to be signed, Base64-encoded.
    messageType String
    Message type. Optional values: RAW, DIGEST.
    signature String
    Signature result, Base64-encoded.

    GetKeyCiphertext

    CiphertextBlob string
    Ciphertext of encryption result, Base64-encoded.
    EncryptionContext string
    Encryption context JSON string.
    Plaintext string
    Plaintext to be encrypted, Base64-encoded.
    CiphertextBlob string
    Ciphertext of encryption result, Base64-encoded.
    EncryptionContext string
    Encryption context JSON string.
    Plaintext string
    Plaintext to be encrypted, Base64-encoded.
    ciphertext_blob string
    Ciphertext of encryption result, Base64-encoded.
    encryption_context string
    Encryption context JSON string.
    plaintext string
    Plaintext to be encrypted, Base64-encoded.
    ciphertextBlob String
    Ciphertext of encryption result, Base64-encoded.
    encryptionContext String
    Encryption context JSON string.
    plaintext String
    Plaintext to be encrypted, Base64-encoded.
    ciphertextBlob string
    Ciphertext of encryption result, Base64-encoded.
    encryptionContext string
    Encryption context JSON string.
    plaintext string
    Plaintext to be encrypted, Base64-encoded.
    ciphertext_blob str
    Ciphertext of encryption result, Base64-encoded.
    encryption_context str
    Encryption context JSON string.
    plaintext str
    Plaintext to be encrypted, Base64-encoded.
    ciphertextBlob String
    Ciphertext of encryption result, Base64-encoded.
    encryptionContext String
    Encryption context JSON string.
    plaintext String
    Plaintext to be encrypted, Base64-encoded.

    GetKeyMultiRegionConfiguration

    MultiRegionKeyType string
    Multi-region key type.
    PrimaryKey Volcengine.GetKeyMultiRegionConfigurationPrimaryKey
    Primary multi-region key transaction identifier and region ID.
    ReplicaKeys List<Volcengine.GetKeyMultiRegionConfigurationReplicaKey>
    Replica multi-region key transaction record number and region ID.
    MultiRegionKeyType string
    Multi-region key type.
    PrimaryKey GetKeyMultiRegionConfigurationPrimaryKey
    Primary multi-region key transaction identifier and region ID.
    ReplicaKeys []GetKeyMultiRegionConfigurationReplicaKey
    Replica multi-region key transaction record number and region ID.
    multi_region_key_type string
    Multi-region key type.
    primary_key object
    Primary multi-region key transaction identifier and region ID.
    replica_keys list(object)
    Replica multi-region key transaction record number and region ID.
    multiRegionKeyType String
    Multi-region key type.
    primaryKey GetKeyMultiRegionConfigurationPrimaryKey
    Primary multi-region key transaction identifier and region ID.
    replicaKeys List<GetKeyMultiRegionConfigurationReplicaKey>
    Replica multi-region key transaction record number and region ID.
    multiRegionKeyType string
    Multi-region key type.
    primaryKey GetKeyMultiRegionConfigurationPrimaryKey
    Primary multi-region key transaction identifier and region ID.
    replicaKeys GetKeyMultiRegionConfigurationReplicaKey[]
    Replica multi-region key transaction record number and region ID.
    multi_region_key_type str
    Multi-region key type.
    primary_key GetKeyMultiRegionConfigurationPrimaryKey
    Primary multi-region key transaction identifier and region ID.
    replica_keys Sequence[GetKeyMultiRegionConfigurationReplicaKey]
    Replica multi-region key transaction record number and region ID.
    multiRegionKeyType String
    Multi-region key type.
    primaryKey Property Map
    Primary multi-region key transaction identifier and region ID.
    replicaKeys List<Property Map>
    Replica multi-region key transaction record number and region ID.

    GetKeyMultiRegionConfigurationPrimaryKey

    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 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.

    GetKeyMultiRegionConfigurationReplicaKey

    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 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.

    GetKeyReEncrypt

    CiphertextBlob string
    Re-encrypted ciphertext, Base64-encoded.
    NewEncryptionContext string
    New encryption context JSON string.
    NewKeyId string
    Target key ID. If not specified, you must provide NewKeyringName and NewKeyName.
    NewKeyName string
    Target key name.
    NewKeyringName string
    Name of the keyring to which the target key belongs.
    OldEncryptionContext string
    Old encryption context JSON string.
    SourceCiphertextBlob string
    Source ciphertext to be re-encrypted, Base64-encoded.
    CiphertextBlob string
    Re-encrypted ciphertext, Base64-encoded.
    NewEncryptionContext string
    New encryption context JSON string.
    NewKeyId string
    Target key ID. If not specified, you must provide NewKeyringName and NewKeyName.
    NewKeyName string
    Target key name.
    NewKeyringName string
    Name of the keyring to which the target key belongs.
    OldEncryptionContext string
    Old encryption context JSON string.
    SourceCiphertextBlob string
    Source ciphertext to be re-encrypted, Base64-encoded.
    ciphertext_blob string
    Re-encrypted ciphertext, Base64-encoded.
    new_encryption_context string
    New encryption context JSON string.
    new_key_id string
    Target key ID. If not specified, you must provide NewKeyringName and NewKeyName.
    new_key_name string
    Target key name.
    new_keyring_name string
    Name of the keyring to which the target key belongs.
    old_encryption_context string
    Old encryption context JSON string.
    source_ciphertext_blob string
    Source ciphertext to be re-encrypted, Base64-encoded.
    ciphertextBlob String
    Re-encrypted ciphertext, Base64-encoded.
    newEncryptionContext String
    New encryption context JSON string.
    newKeyId String
    Target key ID. If not specified, you must provide NewKeyringName and NewKeyName.
    newKeyName String
    Target key name.
    newKeyringName String
    Name of the keyring to which the target key belongs.
    oldEncryptionContext String
    Old encryption context JSON string.
    sourceCiphertextBlob String
    Source ciphertext to be re-encrypted, Base64-encoded.
    ciphertextBlob string
    Re-encrypted ciphertext, Base64-encoded.
    newEncryptionContext string
    New encryption context JSON string.
    newKeyId string
    Target key ID. If not specified, you must provide NewKeyringName and NewKeyName.
    newKeyName string
    Target key name.
    newKeyringName string
    Name of the keyring to which the target key belongs.
    oldEncryptionContext string
    Old encryption context JSON string.
    sourceCiphertextBlob string
    Source ciphertext to be re-encrypted, Base64-encoded.
    ciphertext_blob str
    Re-encrypted ciphertext, Base64-encoded.
    new_encryption_context str
    New encryption context JSON string.
    new_key_id str
    Target key ID. If not specified, you must provide NewKeyringName and NewKeyName.
    new_key_name str
    Target key name.
    new_keyring_name str
    Name of the keyring to which the target key belongs.
    old_encryption_context str
    Old encryption context JSON string.
    source_ciphertext_blob str
    Source ciphertext to be re-encrypted, Base64-encoded.
    ciphertextBlob String
    Re-encrypted ciphertext, Base64-encoded.
    newEncryptionContext String
    New encryption context JSON string.
    newKeyId String
    Target key ID. If not specified, you must provide NewKeyringName and NewKeyName.
    newKeyName String
    Target key name.
    newKeyringName String
    Name of the keyring to which the target key belongs.
    oldEncryptionContext String
    Old encryption context JSON string.
    sourceCiphertextBlob String
    Source ciphertext to be re-encrypted, Base64-encoded.

    GetKeyReplicateKey

    Description string
    Replica key description.
    ReplicaKeyId string
    Replica key ID.
    ReplicaRegion string
    Target region of the replica key.
    Tags List<Volcengine.GetKeyReplicateKeyTag>
    Replica key label.
    Description string
    Replica key description.
    ReplicaKeyId string
    Replica key ID.
    ReplicaRegion string
    Target region of the replica key.
    Tags []GetKeyReplicateKeyTag
    Replica key label.
    description string
    Replica key description.
    replica_key_id string
    Replica key ID.
    replica_region string
    Target region of the replica key.
    tags list(object)
    Replica key label.
    description String
    Replica key description.
    replicaKeyId String
    Replica key ID.
    replicaRegion String
    Target region of the replica key.
    tags List<GetKeyReplicateKeyTag>
    Replica key label.
    description string
    Replica key description.
    replicaKeyId string
    Replica key ID.
    replicaRegion string
    Target region of the replica key.
    tags GetKeyReplicateKeyTag[]
    Replica key label.
    description str
    Replica key description.
    replica_key_id str
    Replica key ID.
    replica_region str
    Target region of the replica key.
    tags Sequence[GetKeyReplicateKeyTag]
    Replica key label.
    description String
    Replica key description.
    replicaKeyId String
    Replica key ID.
    replicaRegion String
    Target region of the replica key.
    tags List<Property Map>
    Replica key label.

    GetKeyReplicateKeyTag

    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 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.

    GetKeyTag

    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 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.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.39
    published on Monday, Jun 1, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial