1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getKmsKeys
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.getKmsKeys

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Use this data source to query detailed information of KMS key

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const example = tencentcloud.getKmsKeys({
        hsmClusterId: "cls-hsm-mwpd9cjm",
        keyState: 0,
        keyUsage: "ALL",
        origin: "TENCENT_KMS",
        searchKeyAlias: "tf_example",
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    example = tencentcloud.get_kms_keys(hsm_cluster_id="cls-hsm-mwpd9cjm",
        key_state=0,
        key_usage="ALL",
        origin="TENCENT_KMS",
        search_key_alias="tf_example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tencentcloud.GetKmsKeys(ctx, &tencentcloud.GetKmsKeysArgs{
    			HsmClusterId:   pulumi.StringRef("cls-hsm-mwpd9cjm"),
    			KeyState:       pulumi.Float64Ref(0),
    			KeyUsage:       pulumi.StringRef("ALL"),
    			Origin:         pulumi.StringRef("TENCENT_KMS"),
    			SearchKeyAlias: pulumi.StringRef("tf_example"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tencentcloud = Pulumi.Tencentcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Tencentcloud.GetKmsKeys.Invoke(new()
        {
            HsmClusterId = "cls-hsm-mwpd9cjm",
            KeyState = 0,
            KeyUsage = "ALL",
            Origin = "TENCENT_KMS",
            SearchKeyAlias = "tf_example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.TencentcloudFunctions;
    import com.pulumi.tencentcloud.inputs.GetKmsKeysArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = TencentcloudFunctions.getKmsKeys(GetKmsKeysArgs.builder()
                .hsmClusterId("cls-hsm-mwpd9cjm")
                .keyState(0)
                .keyUsage("ALL")
                .origin("TENCENT_KMS")
                .searchKeyAlias("tf_example")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: tencentcloud:getKmsKeys
          arguments:
            hsmClusterId: cls-hsm-mwpd9cjm
            keyState: 0
            keyUsage: ALL
            origin: TENCENT_KMS
            searchKeyAlias: tf_example
    

    Using getKmsKeys

    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 getKmsKeys(args: GetKmsKeysArgs, opts?: InvokeOptions): Promise<GetKmsKeysResult>
    function getKmsKeysOutput(args: GetKmsKeysOutputArgs, opts?: InvokeOptions): Output<GetKmsKeysResult>
    def get_kms_keys(hsm_cluster_id: Optional[str] = None,
                     id: Optional[str] = None,
                     key_state: Optional[float] = None,
                     key_usage: Optional[str] = None,
                     order_type: Optional[float] = None,
                     origin: Optional[str] = None,
                     result_output_file: Optional[str] = None,
                     role: Optional[float] = None,
                     search_key_alias: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetKmsKeysResult
    def get_kms_keys_output(hsm_cluster_id: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     key_state: Optional[pulumi.Input[float]] = None,
                     key_usage: Optional[pulumi.Input[str]] = None,
                     order_type: Optional[pulumi.Input[float]] = None,
                     origin: Optional[pulumi.Input[str]] = None,
                     result_output_file: Optional[pulumi.Input[str]] = None,
                     role: Optional[pulumi.Input[float]] = None,
                     search_key_alias: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetKmsKeysResult]
    func GetKmsKeys(ctx *Context, args *GetKmsKeysArgs, opts ...InvokeOption) (*GetKmsKeysResult, error)
    func GetKmsKeysOutput(ctx *Context, args *GetKmsKeysOutputArgs, opts ...InvokeOption) GetKmsKeysResultOutput

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

    public static class GetKmsKeys 
    {
        public static Task<GetKmsKeysResult> InvokeAsync(GetKmsKeysArgs args, InvokeOptions? opts = null)
        public static Output<GetKmsKeysResult> Invoke(GetKmsKeysInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKmsKeysResult> getKmsKeys(GetKmsKeysArgs args, InvokeOptions options)
    public static Output<GetKmsKeysResult> getKmsKeys(GetKmsKeysArgs args, InvokeOptions options)
    
    fn::invoke:
      function: tencentcloud:index/getKmsKeys:getKmsKeys
      arguments:
        # arguments dictionary

    The following arguments are supported:

    HsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    Id string
    KeyState double
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    KeyUsage string
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    OrderType double
    Order to sort the CMK create time. 0 - desc, 1 - asc. Default value is 0.
    Origin string
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    ResultOutputFile string
    Used to save results.
    Role double
    Filter by role of the CMK creator. 0 - created by user, 1 - created by cloud product. Default value is 0.
    SearchKeyAlias string
    Words used to match the results, and the words can be: key_id and alias.
    Tags Dictionary<string, string>
    Tags to filter CMK.
    HsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    Id string
    KeyState float64
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    KeyUsage string
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    OrderType float64
    Order to sort the CMK create time. 0 - desc, 1 - asc. Default value is 0.
    Origin string
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    ResultOutputFile string
    Used to save results.
    Role float64
    Filter by role of the CMK creator. 0 - created by user, 1 - created by cloud product. Default value is 0.
    SearchKeyAlias string
    Words used to match the results, and the words can be: key_id and alias.
    Tags map[string]string
    Tags to filter CMK.
    hsmClusterId String
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    id String
    keyState Double
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    keyUsage String
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    orderType Double
    Order to sort the CMK create time. 0 - desc, 1 - asc. Default value is 0.
    origin String
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    resultOutputFile String
    Used to save results.
    role Double
    Filter by role of the CMK creator. 0 - created by user, 1 - created by cloud product. Default value is 0.
    searchKeyAlias String
    Words used to match the results, and the words can be: key_id and alias.
    tags Map<String,String>
    Tags to filter CMK.
    hsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    id string
    keyState number
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    keyUsage string
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    orderType number
    Order to sort the CMK create time. 0 - desc, 1 - asc. Default value is 0.
    origin string
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    resultOutputFile string
    Used to save results.
    role number
    Filter by role of the CMK creator. 0 - created by user, 1 - created by cloud product. Default value is 0.
    searchKeyAlias string
    Words used to match the results, and the words can be: key_id and alias.
    tags {[key: string]: string}
    Tags to filter CMK.
    hsm_cluster_id str
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    id str
    key_state float
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    key_usage str
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    order_type float
    Order to sort the CMK create time. 0 - desc, 1 - asc. Default value is 0.
    origin str
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    result_output_file str
    Used to save results.
    role float
    Filter by role of the CMK creator. 0 - created by user, 1 - created by cloud product. Default value is 0.
    search_key_alias str
    Words used to match the results, and the words can be: key_id and alias.
    tags Mapping[str, str]
    Tags to filter CMK.
    hsmClusterId String
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    id String
    keyState Number
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    keyUsage String
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    orderType Number
    Order to sort the CMK create time. 0 - desc, 1 - asc. Default value is 0.
    origin String
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    resultOutputFile String
    Used to save results.
    role Number
    Filter by role of the CMK creator. 0 - created by user, 1 - created by cloud product. Default value is 0.
    searchKeyAlias String
    Words used to match the results, and the words can be: key_id and alias.
    tags Map<String>
    Tags to filter CMK.

    getKmsKeys Result

    The following output properties are available:

    Id string
    KeyLists List<GetKmsKeysKeyList>
    A list of KMS keys.
    HsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    KeyState double
    State of CMK.
    KeyUsage string
    Usage of CMK.
    OrderType double
    Origin string
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    ResultOutputFile string
    Role double
    SearchKeyAlias string
    Tags Dictionary<string, string>
    Id string
    KeyLists []GetKmsKeysKeyList
    A list of KMS keys.
    HsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    KeyState float64
    State of CMK.
    KeyUsage string
    Usage of CMK.
    OrderType float64
    Origin string
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    ResultOutputFile string
    Role float64
    SearchKeyAlias string
    Tags map[string]string
    id String
    keyLists List<GetKmsKeysKeyList>
    A list of KMS keys.
    hsmClusterId String
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    keyState Double
    State of CMK.
    keyUsage String
    Usage of CMK.
    orderType Double
    origin String
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    resultOutputFile String
    role Double
    searchKeyAlias String
    tags Map<String,String>
    id string
    keyLists GetKmsKeysKeyList[]
    A list of KMS keys.
    hsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    keyState number
    State of CMK.
    keyUsage string
    Usage of CMK.
    orderType number
    origin string
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    resultOutputFile string
    role number
    searchKeyAlias string
    tags {[key: string]: string}
    id str
    key_lists Sequence[GetKmsKeysKeyList]
    A list of KMS keys.
    hsm_cluster_id str
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    key_state float
    State of CMK.
    key_usage str
    Usage of CMK.
    order_type float
    origin str
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    result_output_file str
    role float
    search_key_alias str
    tags Mapping[str, str]
    id String
    keyLists List<Property Map>
    A list of KMS keys.
    hsmClusterId String
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    keyState Number
    State of CMK.
    keyUsage String
    Usage of CMK.
    orderType Number
    origin String
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    resultOutputFile String
    role Number
    searchKeyAlias String
    tags Map<String>

    Supporting Types

    GetKmsKeysKeyList

    Alias string
    Name of CMK.
    CreateTime double
    Create time of CMK.
    CreatorUin double
    Uin of CMK Creator.
    DeletionDate double
    Delete time of CMK.
    Description string
    Description of CMK.
    HsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    KeyId string
    ID of CMK.
    KeyRotationEnabled bool
    Specify whether to enable key rotation.
    KeyState string
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    KeyUsage string
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    NextRotateTime double
    Next rotate time of CMK when key_rotation_enabled is true.
    Origin string
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    Owner string
    Creator of CMK.
    ValidTo double
    Valid when origin is EXTERNAL, it means the effective date of the key material.
    Alias string
    Name of CMK.
    CreateTime float64
    Create time of CMK.
    CreatorUin float64
    Uin of CMK Creator.
    DeletionDate float64
    Delete time of CMK.
    Description string
    Description of CMK.
    HsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    KeyId string
    ID of CMK.
    KeyRotationEnabled bool
    Specify whether to enable key rotation.
    KeyState string
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    KeyUsage string
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    NextRotateTime float64
    Next rotate time of CMK when key_rotation_enabled is true.
    Origin string
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    Owner string
    Creator of CMK.
    ValidTo float64
    Valid when origin is EXTERNAL, it means the effective date of the key material.
    alias String
    Name of CMK.
    createTime Double
    Create time of CMK.
    creatorUin Double
    Uin of CMK Creator.
    deletionDate Double
    Delete time of CMK.
    description String
    Description of CMK.
    hsmClusterId String
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    keyId String
    ID of CMK.
    keyRotationEnabled Boolean
    Specify whether to enable key rotation.
    keyState String
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    keyUsage String
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    nextRotateTime Double
    Next rotate time of CMK when key_rotation_enabled is true.
    origin String
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    owner String
    Creator of CMK.
    validTo Double
    Valid when origin is EXTERNAL, it means the effective date of the key material.
    alias string
    Name of CMK.
    createTime number
    Create time of CMK.
    creatorUin number
    Uin of CMK Creator.
    deletionDate number
    Delete time of CMK.
    description string
    Description of CMK.
    hsmClusterId string
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    keyId string
    ID of CMK.
    keyRotationEnabled boolean
    Specify whether to enable key rotation.
    keyState string
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    keyUsage string
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    nextRotateTime number
    Next rotate time of CMK when key_rotation_enabled is true.
    origin string
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    owner string
    Creator of CMK.
    validTo number
    Valid when origin is EXTERNAL, it means the effective date of the key material.
    alias str
    Name of CMK.
    create_time float
    Create time of CMK.
    creator_uin float
    Uin of CMK Creator.
    deletion_date float
    Delete time of CMK.
    description str
    Description of CMK.
    hsm_cluster_id str
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    key_id str
    ID of CMK.
    key_rotation_enabled bool
    Specify whether to enable key rotation.
    key_state str
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    key_usage str
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    next_rotate_time float
    Next rotate time of CMK when key_rotation_enabled is true.
    origin str
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    owner str
    Creator of CMK.
    valid_to float
    Valid when origin is EXTERNAL, it means the effective date of the key material.
    alias String
    Name of CMK.
    createTime Number
    Create time of CMK.
    creatorUin Number
    Uin of CMK Creator.
    deletionDate Number
    Delete time of CMK.
    description String
    Description of CMK.
    hsmClusterId String
    The HSM cluster ID corresponding to KMS Advanced Edition (only valid for KMS Exclusive/Managed Edition service instances).
    keyId String
    ID of CMK.
    keyRotationEnabled Boolean
    Specify whether to enable key rotation.
    keyState String
    Filter by state of CMK. 0 - all CMKs are queried, 1 - only Enabled CMKs are queried, 2 - only Disabled CMKs are queried, 3 - only PendingDelete CMKs are queried, 4 - only PendingImport CMKs are queried, 5 - only Archived CMKs are queried.
    keyUsage String
    Filter by usage of CMK. Available values include ALL, ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2, ASYMMETRIC_SIGN_VERIFY_SM2, ASYMMETRIC_SIGN_VERIFY_RSA_2048, ASYMMETRIC_SIGN_VERIFY_ECC. Default value is ENCRYPT_DECRYPT.
    nextRotateTime Number
    Next rotate time of CMK when key_rotation_enabled is true.
    origin String
    Filter by origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user, ALL - all CMKs. Default value is ALL.
    owner String
    Creator of CMK.
    validTo Number
    Valid when origin is EXTERNAL, it means the effective date of the key material.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack