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

tencentcloud.getKmsDescribeKeys

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_lists

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const example = tencentcloud.getKmsDescribeKeys({
        keyIds: [
            "9ffacc8b-6461-11ee-a54e-525400dd8a7d",
            "bffae4ed-6465-11ee-90b2-5254000ef00e",
        ],
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    example = tencentcloud.get_kms_describe_keys(key_ids=[
        "9ffacc8b-6461-11ee-a54e-525400dd8a7d",
        "bffae4ed-6465-11ee-90b2-5254000ef00e",
    ])
    
    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.GetKmsDescribeKeys(ctx, &tencentcloud.GetKmsDescribeKeysArgs{
    			KeyIds: []string{
    				"9ffacc8b-6461-11ee-a54e-525400dd8a7d",
    				"bffae4ed-6465-11ee-90b2-5254000ef00e",
    			},
    		}, 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.GetKmsDescribeKeys.Invoke(new()
        {
            KeyIds = new[]
            {
                "9ffacc8b-6461-11ee-a54e-525400dd8a7d",
                "bffae4ed-6465-11ee-90b2-5254000ef00e",
            },
        });
    
    });
    
    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.GetKmsDescribeKeysArgs;
    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.getKmsDescribeKeys(GetKmsDescribeKeysArgs.builder()
                .keyIds(            
                    "9ffacc8b-6461-11ee-a54e-525400dd8a7d",
                    "bffae4ed-6465-11ee-90b2-5254000ef00e")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: tencentcloud:getKmsDescribeKeys
          arguments:
            keyIds:
              - 9ffacc8b-6461-11ee-a54e-525400dd8a7d
              - bffae4ed-6465-11ee-90b2-5254000ef00e
    

    Using getKmsDescribeKeys

    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 getKmsDescribeKeys(args: GetKmsDescribeKeysArgs, opts?: InvokeOptions): Promise<GetKmsDescribeKeysResult>
    function getKmsDescribeKeysOutput(args: GetKmsDescribeKeysOutputArgs, opts?: InvokeOptions): Output<GetKmsDescribeKeysResult>
    def get_kms_describe_keys(id: Optional[str] = None,
                              key_ids: Optional[Sequence[str]] = None,
                              result_output_file: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetKmsDescribeKeysResult
    def get_kms_describe_keys_output(id: Optional[pulumi.Input[str]] = None,
                              key_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              result_output_file: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetKmsDescribeKeysResult]
    func GetKmsDescribeKeys(ctx *Context, args *GetKmsDescribeKeysArgs, opts ...InvokeOption) (*GetKmsDescribeKeysResult, error)
    func GetKmsDescribeKeysOutput(ctx *Context, args *GetKmsDescribeKeysOutputArgs, opts ...InvokeOption) GetKmsDescribeKeysResultOutput

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

    public static class GetKmsDescribeKeys 
    {
        public static Task<GetKmsDescribeKeysResult> InvokeAsync(GetKmsDescribeKeysArgs args, InvokeOptions? opts = null)
        public static Output<GetKmsDescribeKeysResult> Invoke(GetKmsDescribeKeysInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKmsDescribeKeysResult> getKmsDescribeKeys(GetKmsDescribeKeysArgs args, InvokeOptions options)
    public static Output<GetKmsDescribeKeysResult> getKmsDescribeKeys(GetKmsDescribeKeysArgs args, InvokeOptions options)
    
    fn::invoke:
      function: tencentcloud:index/getKmsDescribeKeys:getKmsDescribeKeys
      arguments:
        # arguments dictionary

    The following arguments are supported:

    KeyIds List<string>
    Query the ID list of CMK, batch query supports up to 100 KeyIds at a time.
    Id string
    ResultOutputFile string
    Used to save results.
    KeyIds []string
    Query the ID list of CMK, batch query supports up to 100 KeyIds at a time.
    Id string
    ResultOutputFile string
    Used to save results.
    keyIds List<String>
    Query the ID list of CMK, batch query supports up to 100 KeyIds at a time.
    id String
    resultOutputFile String
    Used to save results.
    keyIds string[]
    Query the ID list of CMK, batch query supports up to 100 KeyIds at a time.
    id string
    resultOutputFile string
    Used to save results.
    key_ids Sequence[str]
    Query the ID list of CMK, batch query supports up to 100 KeyIds at a time.
    id str
    result_output_file str
    Used to save results.
    keyIds List<String>
    Query the ID list of CMK, batch query supports up to 100 KeyIds at a time.
    id String
    resultOutputFile String
    Used to save results.

    getKmsDescribeKeys Result

    The following output properties are available:

    Id string
    KeyIds List<string>
    KeyLists List<GetKmsDescribeKeysKeyList>
    A list of KMS keys.
    ResultOutputFile string
    Id string
    KeyIds []string
    KeyLists []GetKmsDescribeKeysKeyList
    A list of KMS keys.
    ResultOutputFile string
    id String
    keyIds List<String>
    keyLists List<GetKmsDescribeKeysKeyList>
    A list of KMS keys.
    resultOutputFile String
    id string
    keyIds string[]
    keyLists GetKmsDescribeKeysKeyList[]
    A list of KMS keys.
    resultOutputFile string
    id String
    keyIds List<String>
    keyLists List<Property Map>
    A list of KMS keys.
    resultOutputFile String

    Supporting Types

    GetKmsDescribeKeysKeyList

    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.
    KeyId string
    ID of CMK.
    KeyRotationEnabled bool
    Specify whether to enable key rotation.
    KeyState string
    State of CMK.
    KeyUsage string
    Usage of CMK.
    NextRotateTime double
    Next rotate time of CMK when key_rotation_enabled is true.
    Origin string
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    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.
    KeyId string
    ID of CMK.
    KeyRotationEnabled bool
    Specify whether to enable key rotation.
    KeyState string
    State of CMK.
    KeyUsage string
    Usage of CMK.
    NextRotateTime float64
    Next rotate time of CMK when key_rotation_enabled is true.
    Origin string
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    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.
    keyId String
    ID of CMK.
    keyRotationEnabled Boolean
    Specify whether to enable key rotation.
    keyState String
    State of CMK.
    keyUsage String
    Usage of CMK.
    nextRotateTime Double
    Next rotate time of CMK when key_rotation_enabled is true.
    origin String
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    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.
    keyId string
    ID of CMK.
    keyRotationEnabled boolean
    Specify whether to enable key rotation.
    keyState string
    State of CMK.
    keyUsage string
    Usage of CMK.
    nextRotateTime number
    Next rotate time of CMK when key_rotation_enabled is true.
    origin string
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    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.
    key_id str
    ID of CMK.
    key_rotation_enabled bool
    Specify whether to enable key rotation.
    key_state str
    State of CMK.
    key_usage str
    Usage of CMK.
    next_rotate_time float
    Next rotate time of CMK when key_rotation_enabled is true.
    origin str
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    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.
    keyId String
    ID of CMK.
    keyRotationEnabled Boolean
    Specify whether to enable key rotation.
    keyState String
    State of CMK.
    keyUsage String
    Usage of CMK.
    nextRotateTime Number
    Next rotate time of CMK when key_rotation_enabled is true.
    origin String
    Origin of CMK. TENCENT_KMS - CMK created by KMS, EXTERNAL - CMK imported by user.
    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