1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kms
  6. Key
Viewing docs for volcenginecc v0.0.39
published on Monday, Jun 1, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.39
published on Monday, Jun 1, 2026 by Volcengine

    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
          ciphertext:
            plaintext: tWB54tTvEu47YjRjuuj+fAt5PskpUaxxxxxx
            encryption_context:
              fn::toJSON:
                user: alice
                path: path/to/alice/plaintext.txt
          reEncrypt:
            new_keyring_name: terraform-test
            new_key_name: ccapi-terraform
            new_key_id: 677a846d-a685-4219-b8c6-xxxxxxxx
            source_ciphertext_blob: jrPUHmpTQaiWWtwU8z9JvwAA6TR2e5xxxxxxxx
            old_encryption_context: ""
            new_encryption_context:
              fn::toJSON:
                user: alice
                path: path/to/alice/ccapi.txt
    
    Example coming soon!
    

    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_rotation_operation: Optional[int] = None,
            asymmetric_signature: Optional[KeyAsymmetricSignatureArgs] = None,
            key_archive_operation: Optional[int] = None,
            key_enable_operation: Optional[int] = None,
            ciphertext: Optional[KeyCiphertextArgs] = None,
            key_primary_region: Optional[str] = None,
            asymmetric_ciphertext: Optional[KeyAsymmetricCiphertextArgs] = None,
            key_spec: Optional[str] = None,
            key_usage: Optional[str] = None,
            description: Optional[str] = None,
            multi_region: Optional[bool] = None,
            origin: Optional[str] = None,
            protection_level: Optional[str] = None,
            re_encrypt: Optional[KeyReEncryptArgs] = None,
            replicate_key: Optional[KeyReplicateKeyArgs] = 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.
    
    
    resource "volcenginecc_kms_key" "name" {
        # resource properties
    }

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var keyResource = new Volcenginecc.Kms.Key("keyResource", new()
    {
        KeyName = "string",
        KeyringName = "string",
        KeyRotationOperation = 0,
        AsymmetricSignature = new Volcenginecc.Kms.Inputs.KeyAsymmetricSignatureArgs
        {
            Algorithm = "string",
            Message = "string",
            MessageType = "string",
            Signature = "string",
        },
        KeyArchiveOperation = 0,
        KeyEnableOperation = 0,
        Ciphertext = new Volcenginecc.Kms.Inputs.KeyCiphertextArgs
        {
            CiphertextBlob = "string",
            EncryptionContext = "string",
            Plaintext = "string",
        },
        KeyPrimaryRegion = "string",
        AsymmetricCiphertext = new Volcenginecc.Kms.Inputs.KeyAsymmetricCiphertextArgs
        {
            Algorithm = "string",
            CiphertextBlob = "string",
            Plaintext = "string",
        },
        KeySpec = "string",
        KeyUsage = "string",
        Description = "string",
        MultiRegion = false,
        Origin = "string",
        ProtectionLevel = "string",
        ReEncrypt = new Volcenginecc.Kms.Inputs.KeyReEncryptArgs
        {
            CiphertextBlob = "string",
            NewEncryptionContext = "string",
            NewKeyId = "string",
            NewKeyName = "string",
            NewKeyringName = "string",
            OldEncryptionContext = "string",
            SourceCiphertextBlob = "string",
        },
        ReplicateKey = new Volcenginecc.Kms.Inputs.KeyReplicateKeyArgs
        {
            Description = "string",
            ReplicaKeyId = "string",
            ReplicaRegion = "string",
            Tags = new[]
            {
                new Volcenginecc.Kms.Inputs.KeyReplicateKeyTagArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
        },
        RotateInterval = 0,
        Tags = new[]
        {
            new Volcenginecc.Kms.Inputs.KeyTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
    });
    
    example, err := kms.NewKey(ctx, "keyResource", &kms.KeyArgs{
    	KeyName:              pulumi.String("string"),
    	KeyringName:          pulumi.String("string"),
    	KeyRotationOperation: pulumi.Int(0),
    	AsymmetricSignature: &kms.KeyAsymmetricSignatureArgs{
    		Algorithm:   pulumi.String("string"),
    		Message:     pulumi.String("string"),
    		MessageType: pulumi.String("string"),
    		Signature:   pulumi.String("string"),
    	},
    	KeyArchiveOperation: pulumi.Int(0),
    	KeyEnableOperation:  pulumi.Int(0),
    	Ciphertext: &kms.KeyCiphertextArgs{
    		CiphertextBlob:    pulumi.String("string"),
    		EncryptionContext: pulumi.String("string"),
    		Plaintext:         pulumi.String("string"),
    	},
    	KeyPrimaryRegion: pulumi.String("string"),
    	AsymmetricCiphertext: &kms.KeyAsymmetricCiphertextArgs{
    		Algorithm:      pulumi.String("string"),
    		CiphertextBlob: pulumi.String("string"),
    		Plaintext:      pulumi.String("string"),
    	},
    	KeySpec:         pulumi.String("string"),
    	KeyUsage:        pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	MultiRegion:     pulumi.Bool(false),
    	Origin:          pulumi.String("string"),
    	ProtectionLevel: pulumi.String("string"),
    	ReEncrypt: &kms.KeyReEncryptArgs{
    		CiphertextBlob:       pulumi.String("string"),
    		NewEncryptionContext: pulumi.String("string"),
    		NewKeyId:             pulumi.String("string"),
    		NewKeyName:           pulumi.String("string"),
    		NewKeyringName:       pulumi.String("string"),
    		OldEncryptionContext: pulumi.String("string"),
    		SourceCiphertextBlob: pulumi.String("string"),
    	},
    	ReplicateKey: &kms.KeyReplicateKeyArgs{
    		Description:   pulumi.String("string"),
    		ReplicaKeyId:  pulumi.String("string"),
    		ReplicaRegion: pulumi.String("string"),
    		Tags: kms.KeyReplicateKeyTagArray{
    			&kms.KeyReplicateKeyTagArgs{
    				Key:   pulumi.String("string"),
    				Value: pulumi.String("string"),
    			},
    		},
    	},
    	RotateInterval: pulumi.Int(0),
    	Tags: kms.KeyTagArray{
    		&kms.KeyTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    })
    
    resource "volcenginecc_kms_key" "keyResource" {
      key_name               = "string"
      keyring_name           = "string"
      key_rotation_operation = 0
      asymmetric_signature = {
        algorithm    = "string"
        message      = "string"
        message_type = "string"
        signature    = "string"
      }
      key_archive_operation = 0
      key_enable_operation  = 0
      ciphertext = {
        ciphertext_blob    = "string"
        encryption_context = "string"
        plaintext          = "string"
      }
      key_primary_region = "string"
      asymmetric_ciphertext = {
        algorithm       = "string"
        ciphertext_blob = "string"
        plaintext       = "string"
      }
      key_spec         = "string"
      key_usage        = "string"
      description      = "string"
      multi_region     = false
      origin           = "string"
      protection_level = "string"
      re_encrypt = {
        ciphertext_blob        = "string"
        new_encryption_context = "string"
        new_key_id             = "string"
        new_key_name           = "string"
        new_keyring_name       = "string"
        old_encryption_context = "string"
        source_ciphertext_blob = "string"
      }
      replicate_key = {
        description    = "string"
        replica_key_id = "string"
        replica_region = "string"
        tags = [{
          "key"   = "string"
          "value" = "string"
        }]
      }
      rotate_interval = 0
      tags {
        key   = "string"
        value = "string"
      }
    }
    
    var keyResource = new Key("keyResource", KeyArgs.builder()
        .keyName("string")
        .keyringName("string")
        .keyRotationOperation(0)
        .asymmetricSignature(KeyAsymmetricSignatureArgs.builder()
            .algorithm("string")
            .message("string")
            .messageType("string")
            .signature("string")
            .build())
        .keyArchiveOperation(0)
        .keyEnableOperation(0)
        .ciphertext(KeyCiphertextArgs.builder()
            .ciphertextBlob("string")
            .encryptionContext("string")
            .plaintext("string")
            .build())
        .keyPrimaryRegion("string")
        .asymmetricCiphertext(KeyAsymmetricCiphertextArgs.builder()
            .algorithm("string")
            .ciphertextBlob("string")
            .plaintext("string")
            .build())
        .keySpec("string")
        .keyUsage("string")
        .description("string")
        .multiRegion(false)
        .origin("string")
        .protectionLevel("string")
        .reEncrypt(KeyReEncryptArgs.builder()
            .ciphertextBlob("string")
            .newEncryptionContext("string")
            .newKeyId("string")
            .newKeyName("string")
            .newKeyringName("string")
            .oldEncryptionContext("string")
            .sourceCiphertextBlob("string")
            .build())
        .replicateKey(KeyReplicateKeyArgs.builder()
            .description("string")
            .replicaKeyId("string")
            .replicaRegion("string")
            .tags(KeyReplicateKeyTagArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .rotateInterval(0)
        .tags(KeyTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .build());
    
    key_resource = volcenginecc.kms.Key("keyResource",
        key_name="string",
        keyring_name="string",
        key_rotation_operation=0,
        asymmetric_signature={
            "algorithm": "string",
            "message": "string",
            "message_type": "string",
            "signature": "string",
        },
        key_archive_operation=0,
        key_enable_operation=0,
        ciphertext={
            "ciphertext_blob": "string",
            "encryption_context": "string",
            "plaintext": "string",
        },
        key_primary_region="string",
        asymmetric_ciphertext={
            "algorithm": "string",
            "ciphertext_blob": "string",
            "plaintext": "string",
        },
        key_spec="string",
        key_usage="string",
        description="string",
        multi_region=False,
        origin="string",
        protection_level="string",
        re_encrypt={
            "ciphertext_blob": "string",
            "new_encryption_context": "string",
            "new_key_id": "string",
            "new_key_name": "string",
            "new_keyring_name": "string",
            "old_encryption_context": "string",
            "source_ciphertext_blob": "string",
        },
        replicate_key={
            "description": "string",
            "replica_key_id": "string",
            "replica_region": "string",
            "tags": [{
                "key": "string",
                "value": "string",
            }],
        },
        rotate_interval=0,
        tags=[{
            "key": "string",
            "value": "string",
        }])
    
    const keyResource = new volcenginecc.kms.Key("keyResource", {
        keyName: "string",
        keyringName: "string",
        keyRotationOperation: 0,
        asymmetricSignature: {
            algorithm: "string",
            message: "string",
            messageType: "string",
            signature: "string",
        },
        keyArchiveOperation: 0,
        keyEnableOperation: 0,
        ciphertext: {
            ciphertextBlob: "string",
            encryptionContext: "string",
            plaintext: "string",
        },
        keyPrimaryRegion: "string",
        asymmetricCiphertext: {
            algorithm: "string",
            ciphertextBlob: "string",
            plaintext: "string",
        },
        keySpec: "string",
        keyUsage: "string",
        description: "string",
        multiRegion: false,
        origin: "string",
        protectionLevel: "string",
        reEncrypt: {
            ciphertextBlob: "string",
            newEncryptionContext: "string",
            newKeyId: "string",
            newKeyName: "string",
            newKeyringName: "string",
            oldEncryptionContext: "string",
            sourceCiphertextBlob: "string",
        },
        replicateKey: {
            description: "string",
            replicaKeyId: "string",
            replicaRegion: "string",
            tags: [{
                key: "string",
                value: "string",
            }],
        },
        rotateInterval: 0,
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    type: volcenginecc:kms:Key
    properties:
        asymmetricCiphertext:
            algorithm: string
            ciphertextBlob: string
            plaintext: string
        asymmetricSignature:
            algorithm: string
            message: string
            messageType: string
            signature: string
        ciphertext:
            ciphertextBlob: string
            encryptionContext: string
            plaintext: string
        description: string
        keyArchiveOperation: 0
        keyEnableOperation: 0
        keyName: string
        keyPrimaryRegion: string
        keyRotationOperation: 0
        keySpec: string
        keyUsage: string
        keyringName: string
        multiRegion: false
        origin: string
        protectionLevel: string
        reEncrypt:
            ciphertextBlob: string
            newEncryptionContext: string
            newKeyId: string
            newKeyName: string
            newKeyringName: string
            oldEncryptionContext: string
            sourceCiphertextBlob: string
        replicateKey:
            description: string
            replicaKeyId: string
            replicaRegion: string
            tags:
                - key: string
                  value: string
        rotateInterval: 0
        tags:
            - key: string
              value: string
    

    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-_].
    AsymmetricCiphertext Volcengine.KeyAsymmetricCiphertext
    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.KeyAsymmetricSignature
    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.KeyCiphertext
    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.
    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).
    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.
    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.
    ReEncrypt Volcengine.KeyReEncrypt
    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.KeyReplicateKey
    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].
    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-_].
    AsymmetricCiphertext KeyAsymmetricCiphertextArgs
    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 KeyAsymmetricSignatureArgs
    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 KeyCiphertextArgs
    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.
    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).
    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.
    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.
    ReEncrypt KeyReEncryptArgs
    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 KeyReplicateKeyArgs
    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].
    Tags []KeyTagArgs
    key_name string
    Master key name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
    keyring_name string
    Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
    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.
    description string
    Key description: Length 0–8192 characters.
    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_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_usage string
    Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
    multi_region bool
    Is this a multi-region type master key.
    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].
    tags list(object)
    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-_].
    asymmetricCiphertext KeyAsymmetricCiphertext
    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 KeyAsymmetricSignature
    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 KeyCiphertext
    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.
    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).
    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.
    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.
    reEncrypt KeyReEncrypt
    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 KeyReplicateKey
    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].
    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-_].
    asymmetricCiphertext KeyAsymmetricCiphertext
    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 KeyAsymmetricSignature
    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 KeyCiphertext
    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.
    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).
    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.
    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.
    reEncrypt KeyReEncrypt
    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 KeyReplicateKey
    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].
    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-_].
    asymmetric_ciphertext KeyAsymmetricCiphertextArgs
    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 KeyAsymmetricSignatureArgs
    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 KeyCiphertextArgs
    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.
    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_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_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.
    re_encrypt KeyReEncryptArgs
    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 KeyReplicateKeyArgs
    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].
    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-_].
    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.
    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).
    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.
    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.
    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].
    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.
    created_time number
    Key creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    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_state string
    Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
    last_rotation_time string
    Key last rotation time.
    multi_region_configuration object
    Multi-region key configuration information.
    rotate_state string
    Key rotation status. Options: Enable, Disable.
    schedule_delete_time string
    Key deletion time.
    schedule_rotation_time string
    Key rotation time.
    trn string
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updated_time number
    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,
            asymmetric_ciphertext: Optional[KeyAsymmetricCiphertextArgs] = None,
            asymmetric_signature: Optional[KeyAsymmetricSignatureArgs] = None,
            ciphertext: Optional[KeyCiphertextArgs] = 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_primary_region: 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,
            re_encrypt: Optional[KeyReEncryptArgs] = None,
            replicate_key: Optional[KeyReplicateKeyArgs] = 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}
    import {
      to = volcenginecc_kms_key.example
      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:
    AsymmetricCiphertext Volcengine.KeyAsymmetricCiphertext
    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.KeyAsymmetricSignature
    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.KeyCiphertext
    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.
    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.
    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.
    ReEncrypt Volcengine.KeyReEncrypt
    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.KeyReplicateKey
    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.KeyTag>
    Trn string
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    UpdatedTime int
    Key update time.
    AsymmetricCiphertext KeyAsymmetricCiphertextArgs
    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 KeyAsymmetricSignatureArgs
    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 KeyCiphertextArgs
    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.
    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 KeyMultiRegionConfigurationArgs
    Multi-region key configuration information.
    Origin string
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    ProtectionLevel string
    Key protection level. Options: SOFTWARE, HSM.
    ReEncrypt KeyReEncryptArgs
    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 KeyReplicateKeyArgs
    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 []KeyTagArgs
    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.
    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)
    trn string
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updated_time number
    Key update time.
    asymmetricCiphertext KeyAsymmetricCiphertext
    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 KeyAsymmetricSignature
    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 KeyCiphertext
    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.
    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 KeyMultiRegionConfiguration
    Multi-region key configuration information.
    origin String
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    protectionLevel String
    Key protection level. Options: SOFTWARE, HSM.
    reEncrypt KeyReEncrypt
    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 KeyReplicateKey
    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<KeyTag>
    trn String
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updatedTime Integer
    Key update time.
    asymmetricCiphertext KeyAsymmetricCiphertext
    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 KeyAsymmetricSignature
    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 KeyCiphertext
    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.
    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 KeyMultiRegionConfiguration
    Multi-region key configuration information.
    origin string
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    protectionLevel string
    Key protection level. Options: SOFTWARE, HSM.
    reEncrypt KeyReEncrypt
    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 KeyReplicateKey
    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 KeyTag[]
    trn string
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updatedTime number
    Key update time.
    asymmetric_ciphertext KeyAsymmetricCiphertextArgs
    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 KeyAsymmetricSignatureArgs
    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 KeyCiphertextArgs
    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.
    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 KeyMultiRegionConfigurationArgs
    Multi-region key configuration information.
    origin str
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    protection_level str
    Key protection level. Options: SOFTWARE, HSM.
    re_encrypt KeyReEncryptArgs
    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 KeyReplicateKeyArgs
    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[KeyTagArgs]
    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.
    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>
    trn String
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updatedTime Number
    Key update time.

    Supporting Types

    KeyAsymmetricCiphertext, KeyAsymmetricCiphertextArgs

    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.

    KeyAsymmetricSignature, KeyAsymmetricSignatureArgs

    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.

    KeyCiphertext, KeyCiphertextArgs

    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.

    KeyMultiRegionConfiguration, KeyMultiRegionConfigurationArgs

    MultiRegionKeyType string
    Multi-region key type.
    PrimaryKey KeyMultiRegionConfigurationPrimaryKey
    Primary multi-region key transaction identifier and region ID.
    ReplicaKeys []KeyMultiRegionConfigurationReplicaKey
    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)
    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 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 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.

    KeyReEncrypt, KeyReEncryptArgs

    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.

    KeyReplicateKey, KeyReplicateKeyArgs

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

    KeyReplicateKeyTag, KeyReplicateKeyTagArgs

    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.

    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 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.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.39
    published on Monday, Jun 1, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial