tencentcloud 1.82.35, Nov 7 25

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getKmsWhiteBoxKeyDetails

Start a Neo task

Explain and create a tencentcloud.getKmsWhiteBoxKeyDetails resource

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const example = tencentcloud.getKmsWhiteBoxKeyDetails({
    keyStatus: 0,
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_kms_white_box_key_details(key_status=0)

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.GetKmsWhiteBoxKeyDetails(ctx, &tencentcloud.GetKmsWhiteBoxKeyDetailsArgs{
			KeyStatus: pulumi.Float64Ref(0),
		}, 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.GetKmsWhiteBoxKeyDetails.Invoke(new()
    {
        KeyStatus = 0,
    });

});

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.GetKmsWhiteBoxKeyDetailsArgs;
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.getKmsWhiteBoxKeyDetails(GetKmsWhiteBoxKeyDetailsArgs.builder()
            .keyStatus(0)
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getKmsWhiteBoxKeyDetails
      arguments:
        keyStatus: 0

Using getKmsWhiteBoxKeyDetails

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 getKmsWhiteBoxKeyDetails(args: GetKmsWhiteBoxKeyDetailsArgs, opts?: InvokeOptions): Promise<GetKmsWhiteBoxKeyDetailsResult>
function getKmsWhiteBoxKeyDetailsOutput(args: GetKmsWhiteBoxKeyDetailsOutputArgs, opts?: InvokeOptions): Output<GetKmsWhiteBoxKeyDetailsResult>

def get_kms_white_box_key_details(id: Optional[str] = None,
                                  key_status: Optional[float] = None,
                                  result_output_file: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetKmsWhiteBoxKeyDetailsResult
def get_kms_white_box_key_details_output(id: Optional[pulumi.Input[str]] = None,
                                  key_status: Optional[pulumi.Input[float]] = None,
                                  result_output_file: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetKmsWhiteBoxKeyDetailsResult]

func GetKmsWhiteBoxKeyDetails(ctx *Context, args *GetKmsWhiteBoxKeyDetailsArgs, opts ...InvokeOption) (*GetKmsWhiteBoxKeyDetailsResult, error)
func GetKmsWhiteBoxKeyDetailsOutput(ctx *Context, args *GetKmsWhiteBoxKeyDetailsOutputArgs, opts ...InvokeOption) GetKmsWhiteBoxKeyDetailsResultOutput

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

public static class GetKmsWhiteBoxKeyDetails 
{
    public static Task<GetKmsWhiteBoxKeyDetailsResult> InvokeAsync(GetKmsWhiteBoxKeyDetailsArgs args, InvokeOptions? opts = null)
    public static Output<GetKmsWhiteBoxKeyDetailsResult> Invoke(GetKmsWhiteBoxKeyDetailsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKmsWhiteBoxKeyDetailsResult> getKmsWhiteBoxKeyDetails(GetKmsWhiteBoxKeyDetailsArgs args, InvokeOptions options)
public static Output<GetKmsWhiteBoxKeyDetailsResult> getKmsWhiteBoxKeyDetails(GetKmsWhiteBoxKeyDetailsArgs args, InvokeOptions options)

fn::invoke:
  function: tencentcloud:index/getKmsWhiteBoxKeyDetails:getKmsWhiteBoxKeyDetails
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
KeyStatus double: Filter condition: status of the key, 0: disabled, 1: enabled.
ResultOutputFile string: Used to save results.

Id string
KeyStatus float64: Filter condition: status of the key, 0: disabled, 1: enabled.
ResultOutputFile string: Used to save results.

id String
keyStatus Double: Filter condition: status of the key, 0: disabled, 1: enabled.
resultOutputFile String: Used to save results.

id string
keyStatus number: Filter condition: status of the key, 0: disabled, 1: enabled.
resultOutputFile string: Used to save results.

id str
key_status float: Filter condition: status of the key, 0: disabled, 1: enabled.
result_output_file str: Used to save results.

id String
keyStatus Number: Filter condition: status of the key, 0: disabled, 1: enabled.
resultOutputFile String: Used to save results.

getKmsWhiteBoxKeyDetails Result

The following output properties are available:

Id string
KeyInfos List<GetKmsWhiteBoxKeyDetailsKeyInfo>: List of white box key information.
KeyStatus double
ResultOutputFile string

Id string
KeyInfos []GetKmsWhiteBoxKeyDetailsKeyInfo: List of white box key information.
KeyStatus float64
ResultOutputFile string

id String
keyInfos List<GetKmsWhiteBoxKeyDetailsKeyInfo>: List of white box key information.
keyStatus Double
resultOutputFile String

id string
keyInfos GetKmsWhiteBoxKeyDetailsKeyInfo[]: List of white box key information.
keyStatus number
resultOutputFile string

id str
key_infos Sequence[GetKmsWhiteBoxKeyDetailsKeyInfo]: List of white box key information.
key_status float
result_output_file str

id String
keyInfos List<Property Map>: List of white box key information.
keyStatus Number
resultOutputFile String

Supporting Types

GetKmsWhiteBoxKeyDetailsKeyInfo

Algorithm string: The type of algorithm used by the key.
Alias string: As an alias for a key that is easier to identify and easier to understand, it cannot be empty and is a combination of 1-60 alphanumeric characters - _. The first character must be a letter or number. It cannot be repeated.
CreateTime double: Key creation time, Unix timestamp.
CreatorUin double: Creator.
DecryptKey string: White box decryption key, base64 encoded.
Description string: Description of the key.
DeviceFingerprintBind bool: Is there a device fingerprint bound to the current key?.
EncryptKey string: White box encryption key, base64 encoded.
KeyId string: Globally unique identifier for the white box key.
OwnerUin double: Creator.
ResourceId string: Resource ID, format: creatorUin/$creatorUin/$keyId.
Status string: The status of the white box key, the value is: Enabled | Disabled.

Algorithm string: The type of algorithm used by the key.
Alias string: As an alias for a key that is easier to identify and easier to understand, it cannot be empty and is a combination of 1-60 alphanumeric characters - _. The first character must be a letter or number. It cannot be repeated.
CreateTime float64: Key creation time, Unix timestamp.
CreatorUin float64: Creator.
DecryptKey string: White box decryption key, base64 encoded.
Description string: Description of the key.
DeviceFingerprintBind bool: Is there a device fingerprint bound to the current key?.
EncryptKey string: White box encryption key, base64 encoded.
KeyId string: Globally unique identifier for the white box key.
OwnerUin float64: Creator.
ResourceId string: Resource ID, format: creatorUin/$creatorUin/$keyId.
Status string: The status of the white box key, the value is: Enabled | Disabled.

algorithm String: The type of algorithm used by the key.
alias String: As an alias for a key that is easier to identify and easier to understand, it cannot be empty and is a combination of 1-60 alphanumeric characters - _. The first character must be a letter or number. It cannot be repeated.
createTime Double: Key creation time, Unix timestamp.
creatorUin Double: Creator.
decryptKey String: White box decryption key, base64 encoded.
description String: Description of the key.
deviceFingerprintBind Boolean: Is there a device fingerprint bound to the current key?.
encryptKey String: White box encryption key, base64 encoded.
keyId String: Globally unique identifier for the white box key.
ownerUin Double: Creator.
resourceId String: Resource ID, format: creatorUin/$creatorUin/$keyId.
status String: The status of the white box key, the value is: Enabled | Disabled.

algorithm string: The type of algorithm used by the key.
alias string: As an alias for a key that is easier to identify and easier to understand, it cannot be empty and is a combination of 1-60 alphanumeric characters - _. The first character must be a letter or number. It cannot be repeated.
createTime number: Key creation time, Unix timestamp.
creatorUin number: Creator.
decryptKey string: White box decryption key, base64 encoded.
description string: Description of the key.
deviceFingerprintBind boolean: Is there a device fingerprint bound to the current key?.
encryptKey string: White box encryption key, base64 encoded.
keyId string: Globally unique identifier for the white box key.
ownerUin number: Creator.
resourceId string: Resource ID, format: creatorUin/$creatorUin/$keyId.
status string: The status of the white box key, the value is: Enabled | Disabled.

algorithm str: The type of algorithm used by the key.
alias str: As an alias for a key that is easier to identify and easier to understand, it cannot be empty and is a combination of 1-60 alphanumeric characters - _. The first character must be a letter or number. It cannot be repeated.
create_time float: Key creation time, Unix timestamp.
creator_uin float: Creator.
decrypt_key str: White box decryption key, base64 encoded.
description str: Description of the key.
device_fingerprint_bind bool: Is there a device fingerprint bound to the current key?.
encrypt_key str: White box encryption key, base64 encoded.
key_id str: Globally unique identifier for the white box key.
owner_uin float: Creator.
resource_id str: Resource ID, format: creatorUin/$creatorUin/$keyId.
status str: The status of the white box key, the value is: Enabled | Disabled.

algorithm String: The type of algorithm used by the key.
alias String: As an alias for a key that is easier to identify and easier to understand, it cannot be empty and is a combination of 1-60 alphanumeric characters - _. The first character must be a letter or number. It cannot be repeated.
createTime Number: Key creation time, Unix timestamp.
creatorUin Number: Creator.
decryptKey String: White box decryption key, base64 encoded.
description String: Description of the key.
deviceFingerprintBind Boolean: Is there a device fingerprint bound to the current key?.
encryptKey String: White box encryption key, base64 encoded.
keyId String: Globally unique identifier for the white box key.
ownerUin Number: Creator.
resourceId String: Resource ID, format: creatorUin/$creatorUin/$keyId.
status String: The status of the white box key, the value is: Enabled | Disabled.

Package Details

Repository: tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes: This Pulumi package is based on the tencentcloud Terraform Provider.

tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getKmsWhiteBoxKeyDetails

On this page

On this page

Example Usage

Using getKmsWhiteBoxKeyDetails

getKmsWhiteBoxKeyDetails Result

Supporting Types

GetKmsWhiteBoxKeyDetailsKeyInfo

Package Details

On this page

On this page