1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kms
  6. getKey
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kms.getKey

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 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: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]
    func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)
func LookupKeyOutput(ctx *Context, args *LookupKeyOutputArgs, opts ...InvokeOption) LookupKeyResultOutput

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

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

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

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getKey Result

    The following output properties are available:

    CreatedTime int
    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-_].
    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.
    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.
    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-_].
    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.
    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.
    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-_].
    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.
    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.
    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-_].
    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.
    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.
    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_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.
    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.
    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-_].
    keyRotationOperation Number
    User master key rotation operation (enter 1 to enable, 2 to disable).
    keySpec String
    Symmetric keys: SYMMETRIC256, SYMMETRIC128; asymmetric keys: RSA2048, RSA3072, RSA4096, ECP256, ECP256K, ECP384, ECP521, ECSM2.
    keyState String
    Key status: Enable, Disable, PendingDelete, Archived, PendingImport.
    keyUsage String
    Key usage. Options: ENCRYPTDECRYPT, SIGNVERIFY, GENERATEVERIFYMAC.
    keyringName String
    Key ring name. Length 2–31 characters. Valid characters: [a-zA-Z0-9-_].
    lastRotationTime String
    Key last rotation time.
    multiRegion Boolean
    Is this a multi-region type master key.
    multiRegionConfiguration Property Map
    Multi-region key configuration information.
    origin String
    Key source. Options: CloudKMS, External, ExternalKeyStore.
    protectionLevel String
    Key protection level. Options: SOFTWARE, HSM.
    rotateInterval Number
    Key rotation period (days). Range: [90, 2560].
    rotateState String
    Key rotation status. Options: Enable, Disable.
    scheduleDeleteTime String
    Key deletion time.
    scheduleRotationTime String
    Key rotation time.
    tags List<Property Map>
    KMS key label information.
    trn String
    Resource name. Format should be trn:${Service}:${Region}:${AccountID}:${ResourcePath}.
    updatedTime Number
    Key update time.

    Supporting Types

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

    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 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.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.