1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. kms
  5. Key
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.kms.Key

bytepluscc logo
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    密钥管理服务（Key Management Service）是火山引擎上一站式的密钥管理和数据加密服务平台。提供简单易用的加密接口，KMS 帮助用户轻松管理密钥、保护云上核心数据的安全。同时极大降低用户自行部署密码基础设施的采购、研发成本。帮助业务轻松满足监管和合规需求。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const kMSKeyDemo = new bytepluscc.kms.Key("KMSKeyDemo", {
    keyringName: "KMSKeyDemo",
    keyName: "KMSKeyDemoKeyName",
    keySpec: "SYMMETRIC_256",
    description: "description KMSKeyDemo",
    keyUsage: "ENCRYPT_DECRYPT",
    protectionLevel: "HSM",
    rotateState: "Enable",
    origin: "CloudKMS",
    multiRegion: false,
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

k_ms_key_demo = bytepluscc.kms.Key("KMSKeyDemo",
    keyring_name="KMSKeyDemo",
    key_name="KMSKeyDemoKeyName",
    key_spec="SYMMETRIC_256",
    description="description KMSKeyDemo",
    key_usage="ENCRYPT_DECRYPT",
    protection_level="HSM",
    rotate_state="Enable",
    origin="CloudKMS",
    multi_region=False,
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/kms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kms.NewKey(ctx, "KMSKeyDemo", &kms.KeyArgs{
			KeyringName:     pulumi.String("KMSKeyDemo"),
			KeyName:         pulumi.String("KMSKeyDemoKeyName"),
			KeySpec:         pulumi.String("SYMMETRIC_256"),
			Description:     pulumi.String("description KMSKeyDemo"),
			KeyUsage:        pulumi.String("ENCRYPT_DECRYPT"),
			ProtectionLevel: pulumi.String("HSM"),
			RotateState:     pulumi.String("Enable"),
			Origin:          pulumi.String("CloudKMS"),
			MultiRegion:     pulumi.Bool(false),
			Tags: kms.KeyTagArray{
				&kms.KeyTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var kMSKeyDemo = new Bytepluscc.Kms.Key("KMSKeyDemo", new()
    {
        KeyringName = "KMSKeyDemo",
        KeyName = "KMSKeyDemoKeyName",
        KeySpec = "SYMMETRIC_256",
        Description = "description KMSKeyDemo",
        KeyUsage = "ENCRYPT_DECRYPT",
        ProtectionLevel = "HSM",
        RotateState = "Enable",
        Origin = "CloudKMS",
        MultiRegion = false,
        Tags = new[]
        {
            new Bytepluscc.Kms.Inputs.KeyTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.kms.Key;
import com.byteplus.bytepluscc.kms.KeyArgs;
import com.pulumi.bytepluscc.kms.inputs.KeyTagArgs;
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) {
        var kMSKeyDemo = new Key("kMSKeyDemo", KeyArgs.builder()
            .keyringName("KMSKeyDemo")
            .keyName("KMSKeyDemoKeyName")
            .keySpec("SYMMETRIC_256")
            .description("description KMSKeyDemo")
            .keyUsage("ENCRYPT_DECRYPT")
            .protectionLevel("HSM")
            .rotateState("Enable")
            .origin("CloudKMS")
            .multiRegion(false)
            .tags(KeyTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  kMSKeyDemo:
    type: bytepluscc: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
      tags:
        - key: env
          value: test

    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,
        description: Optional[str] = None,
        key_spec: Optional[str] = None,
        key_usage: Optional[str] = None,
        multi_region: Optional[bool] = None,
        origin: Optional[str] = None,
        protection_level: Optional[str] = None,
        rotate_state: Optional[str] = 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: bytepluscc:kms:Key
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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 Bytepluscc.Kms.Key("keyResource", new()
{
    KeyName = "string",
    KeyringName = "string",
    Description = "string",
    KeySpec = "string",
    KeyUsage = "string",
    MultiRegion = false,
    Origin = "string",
    ProtectionLevel = "string",
    RotateState = "string",
    Tags = new[]
    {
        new Bytepluscc.Kms.Inputs.KeyTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := kms.NewKey(ctx, "keyResource", &kms.KeyArgs{
	KeyName:         pulumi.String("string"),
	KeyringName:     pulumi.String("string"),
	Description:     pulumi.String("string"),
	KeySpec:         pulumi.String("string"),
	KeyUsage:        pulumi.String("string"),
	MultiRegion:     pulumi.Bool(false),
	Origin:          pulumi.String("string"),
	ProtectionLevel: pulumi.String("string"),
	RotateState:     pulumi.String("string"),
	Tags: kms.KeyTagArray{
		&kms.KeyTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var keyResource = new Key("keyResource", KeyArgs.builder()
    .keyName("string")
    .keyringName("string")
    .description("string")
    .keySpec("string")
    .keyUsage("string")
    .multiRegion(false)
    .origin("string")
    .protectionLevel("string")
    .rotateState("string")
    .tags(KeyTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    key_resource = bytepluscc.kms.Key("keyResource",
    key_name="string",
    keyring_name="string",
    description="string",
    key_spec="string",
    key_usage="string",
    multi_region=False,
    origin="string",
    protection_level="string",
    rotate_state="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const keyResource = new bytepluscc.kms.Key("keyResource", {
    keyName: "string",
    keyringName: "string",
    description: "string",
    keySpec: "string",
    keyUsage: "string",
    multiRegion: false,
    origin: "string",
    protectionLevel: "string",
    rotateState: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: bytepluscc:kms:Key
properties:
    description: string
    keyName: string
    keySpec: string
    keyUsage: string
    keyringName: string
    multiRegion: false
    origin: string
    protectionLevel: string
    rotateState: string
    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
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    KeyringName string
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    Description string
    密钥描述:长度为 0 - 8192 个字符。
    KeySpec string
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    KeyUsage string
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    MultiRegion bool
    是否为 Multi-region 类型的主密钥。
    Origin string
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    ProtectionLevel string
    密钥保护级别，取值：SOFTWARE，HSM。
    RotateState string
    密钥轮转状态，取值：Enable，Disable。
    Tags List<Byteplus.KeyTag>
    KeyName string
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    KeyringName string
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    Description string
    密钥描述:长度为 0 - 8192 个字符。
    KeySpec string
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    KeyUsage string
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    MultiRegion bool
    是否为 Multi-region 类型的主密钥。
    Origin string
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    ProtectionLevel string
    密钥保护级别，取值：SOFTWARE，HSM。
    RotateState string
    密钥轮转状态，取值：Enable，Disable。
    Tags []KeyTagArgs
    keyName String
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    keyringName String
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    description String
    密钥描述:长度为 0 - 8192 个字符。
    keySpec String
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    keyUsage String
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    multiRegion Boolean
    是否为 Multi-region 类型的主密钥。
    origin String
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    protectionLevel String
    密钥保护级别，取值：SOFTWARE，HSM。
    rotateState String
    密钥轮转状态，取值：Enable，Disable。
    tags List<KeyTag>
    keyName string
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    keyringName string
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    description string
    密钥描述:长度为 0 - 8192 个字符。
    keySpec string
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    keyUsage string
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    multiRegion boolean
    是否为 Multi-region 类型的主密钥。
    origin string
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    protectionLevel string
    密钥保护级别，取值：SOFTWARE，HSM。
    rotateState string
    密钥轮转状态，取值：Enable，Disable。
    tags KeyTag[]
    key_name str
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    keyring_name str
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    description str
    密钥描述:长度为 0 - 8192 个字符。
    key_spec str
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    key_usage str
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    multi_region bool
    是否为 Multi-region 类型的主密钥。
    origin str
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    protection_level str
    密钥保护级别，取值：SOFTWARE，HSM。
    rotate_state str
    密钥轮转状态，取值：Enable，Disable。
    tags Sequence[KeyTagArgs]
    keyName String
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    keyringName String
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    description String
    密钥描述:长度为 0 - 8192 个字符。
    keySpec String
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    keyUsage String
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    multiRegion Boolean
    是否为 Multi-region 类型的主密钥。
    origin String
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    protectionLevel String
    密钥保护级别，取值：SOFTWARE，HSM。
    rotateState String
    密钥轮转状态，取值：Enable，Disable。
    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
    密钥创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyId string
    密钥唯一标识符，UUID形式。
    KeyMaterialExpireTime string
    密钥材料过期时间，当值为空时表示不会过期。
    KeyStateValue string
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    LastRotationTime string
    密钥最后轮转时间。
    MultiRegionConfiguration Byteplus.KeyMultiRegionConfiguration
    Multi-region key 配置信息。
    ScheduleDeleteTime string
    密钥删除时间。
    ScheduleRotationTime string
    密钥轮转时间。
    Trn string
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    UpdatedTime int
    密钥更新时间。
    CreatedTime int
    密钥创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyId string
    密钥唯一标识符，UUID形式。
    KeyMaterialExpireTime string
    密钥材料过期时间，当值为空时表示不会过期。
    KeyState string
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    LastRotationTime string
    密钥最后轮转时间。
    MultiRegionConfiguration KeyMultiRegionConfiguration
    Multi-region key 配置信息。
    ScheduleDeleteTime string
    密钥删除时间。
    ScheduleRotationTime string
    密钥轮转时间。
    Trn string
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    UpdatedTime int
    密钥更新时间。
    createdTime Integer
    密钥创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    keyId String
    密钥唯一标识符，UUID形式。
    keyMaterialExpireTime String
    密钥材料过期时间，当值为空时表示不会过期。
    keyState String
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    lastRotationTime String
    密钥最后轮转时间。
    multiRegionConfiguration KeyMultiRegionConfiguration
    Multi-region key 配置信息。
    scheduleDeleteTime String
    密钥删除时间。
    scheduleRotationTime String
    密钥轮转时间。
    trn String
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    updatedTime Integer
    密钥更新时间。
    createdTime number
    密钥创建时间。
    id string
    The provider-assigned unique ID for this managed resource.
    keyId string
    密钥唯一标识符，UUID形式。
    keyMaterialExpireTime string
    密钥材料过期时间，当值为空时表示不会过期。
    keyState string
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    lastRotationTime string
    密钥最后轮转时间。
    multiRegionConfiguration KeyMultiRegionConfiguration
    Multi-region key 配置信息。
    scheduleDeleteTime string
    密钥删除时间。
    scheduleRotationTime string
    密钥轮转时间。
    trn string
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    updatedTime number
    密钥更新时间。
    created_time int
    密钥创建时间。
    id str
    The provider-assigned unique ID for this managed resource.
    key_id str
    密钥唯一标识符，UUID形式。
    key_material_expire_time str
    密钥材料过期时间，当值为空时表示不会过期。
    key_state str
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    last_rotation_time str
    密钥最后轮转时间。
    multi_region_configuration KeyMultiRegionConfiguration
    Multi-region key 配置信息。
    schedule_delete_time str
    密钥删除时间。
    schedule_rotation_time str
    密钥轮转时间。
    trn str
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    updated_time int
    密钥更新时间。
    createdTime Number
    密钥创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    keyId String
    密钥唯一标识符，UUID形式。
    keyMaterialExpireTime String
    密钥材料过期时间，当值为空时表示不会过期。
    keyState String
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    lastRotationTime String
    密钥最后轮转时间。
    multiRegionConfiguration Property Map
    Multi-region key 配置信息。
    scheduleDeleteTime String
    密钥删除时间。
    scheduleRotationTime String
    密钥轮转时间。
    trn String
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    updatedTime Number
    密钥更新时间。

    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,
        created_time: Optional[int] = None,
        description: Optional[str] = None,
        key_id: Optional[str] = None,
        key_material_expire_time: Optional[str] = None,
        key_name: Optional[str] = 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,
        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: bytepluscc:kms:Key    get:      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:
    CreatedTime int
    密钥创建时间。
    Description string
    密钥描述:长度为 0 - 8192 个字符。
    KeyId string
    密钥唯一标识符，UUID形式。
    KeyMaterialExpireTime string
    密钥材料过期时间，当值为空时表示不会过期。
    KeyName string
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    KeySpec string
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    KeyStateValue string
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    KeyUsage string
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    KeyringName string
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    LastRotationTime string
    密钥最后轮转时间。
    MultiRegion bool
    是否为 Multi-region 类型的主密钥。
    MultiRegionConfiguration Byteplus.KeyMultiRegionConfiguration
    Multi-region key 配置信息。
    Origin string
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    ProtectionLevel string
    密钥保护级别，取值：SOFTWARE，HSM。
    RotateState string
    密钥轮转状态，取值：Enable，Disable。
    ScheduleDeleteTime string
    密钥删除时间。
    ScheduleRotationTime string
    密钥轮转时间。
    Tags List<Byteplus.KeyTag>
    Trn string
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    UpdatedTime int
    密钥更新时间。
    CreatedTime int
    密钥创建时间。
    Description string
    密钥描述:长度为 0 - 8192 个字符。
    KeyId string
    密钥唯一标识符，UUID形式。
    KeyMaterialExpireTime string
    密钥材料过期时间，当值为空时表示不会过期。
    KeyName string
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    KeySpec string
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    KeyState string
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    KeyUsage string
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    KeyringName string
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    LastRotationTime string
    密钥最后轮转时间。
    MultiRegion bool
    是否为 Multi-region 类型的主密钥。
    MultiRegionConfiguration KeyMultiRegionConfigurationArgs
    Multi-region key 配置信息。
    Origin string
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    ProtectionLevel string
    密钥保护级别，取值：SOFTWARE，HSM。
    RotateState string
    密钥轮转状态，取值：Enable，Disable。
    ScheduleDeleteTime string
    密钥删除时间。
    ScheduleRotationTime string
    密钥轮转时间。
    Tags []KeyTagArgs
    Trn string
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    UpdatedTime int
    密钥更新时间。
    createdTime Integer
    密钥创建时间。
    description String
    密钥描述:长度为 0 - 8192 个字符。
    keyId String
    密钥唯一标识符，UUID形式。
    keyMaterialExpireTime String
    密钥材料过期时间，当值为空时表示不会过期。
    keyName String
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    keySpec String
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    keyState String
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    keyUsage String
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    keyringName String
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    lastRotationTime String
    密钥最后轮转时间。
    multiRegion Boolean
    是否为 Multi-region 类型的主密钥。
    multiRegionConfiguration KeyMultiRegionConfiguration
    Multi-region key 配置信息。
    origin String
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    protectionLevel String
    密钥保护级别，取值：SOFTWARE，HSM。
    rotateState String
    密钥轮转状态，取值：Enable，Disable。
    scheduleDeleteTime String
    密钥删除时间。
    scheduleRotationTime String
    密钥轮转时间。
    tags List<KeyTag>
    trn String
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    updatedTime Integer
    密钥更新时间。
    createdTime number
    密钥创建时间。
    description string
    密钥描述:长度为 0 - 8192 个字符。
    keyId string
    密钥唯一标识符，UUID形式。
    keyMaterialExpireTime string
    密钥材料过期时间，当值为空时表示不会过期。
    keyName string
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    keySpec string
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    keyState string
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    keyUsage string
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    keyringName string
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    lastRotationTime string
    密钥最后轮转时间。
    multiRegion boolean
    是否为 Multi-region 类型的主密钥。
    multiRegionConfiguration KeyMultiRegionConfiguration
    Multi-region key 配置信息。
    origin string
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    protectionLevel string
    密钥保护级别，取值：SOFTWARE，HSM。
    rotateState string
    密钥轮转状态，取值：Enable，Disable。
    scheduleDeleteTime string
    密钥删除时间。
    scheduleRotationTime string
    密钥轮转时间。
    tags KeyTag[]
    trn string
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    updatedTime number
    密钥更新时间。
    created_time int
    密钥创建时间。
    description str
    密钥描述:长度为 0 - 8192 个字符。
    key_id str
    密钥唯一标识符，UUID形式。
    key_material_expire_time str
    密钥材料过期时间，当值为空时表示不会过期。
    key_name str
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    key_spec str
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    key_state str
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    key_usage str
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    keyring_name str
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    last_rotation_time str
    密钥最后轮转时间。
    multi_region bool
    是否为 Multi-region 类型的主密钥。
    multi_region_configuration KeyMultiRegionConfigurationArgs
    Multi-region key 配置信息。
    origin str
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    protection_level str
    密钥保护级别，取值：SOFTWARE，HSM。
    rotate_state str
    密钥轮转状态，取值：Enable，Disable。
    schedule_delete_time str
    密钥删除时间。
    schedule_rotation_time str
    密钥轮转时间。
    tags Sequence[KeyTagArgs]
    trn str
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    updated_time int
    密钥更新时间。
    createdTime Number
    密钥创建时间。
    description String
    密钥描述:长度为 0 - 8192 个字符。
    keyId String
    密钥唯一标识符，UUID形式。
    keyMaterialExpireTime String
    密钥材料过期时间，当值为空时表示不会过期。
    keyName String
    主密钥名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    keySpec String
    对称密钥：SYMMETRIC256，SYMMETRIC128，非对称密钥：RSA2048，RSA3072，RSA4096，ECP256，ECP256K，ECP384，ECP521，ECSM2。
    keyState String
    密钥状态：Enable，Disable，PendingDelete，Archived，PendingImport。
    keyUsage String
    密钥用途，取值：ENCRYPTDECRYPT，SIGNVERIFY，GENERATEVERIFYMAC。
    keyringName String
    密钥环名称，长度为 2 - 31 个字符，合法字符：[a-zA-Z0-9-_]。
    lastRotationTime String
    密钥最后轮转时间。
    multiRegion Boolean
    是否为 Multi-region 类型的主密钥。
    multiRegionConfiguration Property Map
    Multi-region key 配置信息。
    origin String
    密钥来源，取值：CloudKMS，External，ExternalKeyStore。
    protectionLevel String
    密钥保护级别，取值：SOFTWARE，HSM。
    rotateState String
    密钥轮转状态，取值：Enable，Disable。
    scheduleDeleteTime String
    密钥删除时间。
    scheduleRotationTime String
    密钥轮转时间。
    tags List<Property Map>
    trn String
    资源名称，格式应为 trn:${Service}:${Region}:${AccountID}:${ResourcePath}。
    updatedTime Number
    密钥更新时间。

    Supporting Types

    KeyMultiRegionConfiguration, KeyMultiRegionConfigurationArgs

    MultiRegionKeyType string
    多区域密钥的类型。
    PrimaryKey KeyMultiRegionConfigurationPrimaryKey
    主多区域键的事务识别号和区域 ID。
    ReplicaKeys []KeyMultiRegionConfigurationReplicaKey
    multiRegionKeyType String
    多区域密钥的类型。
    primaryKey KeyMultiRegionConfigurationPrimaryKey
    主多区域键的事务识别号和区域 ID。
    replicaKeys List<KeyMultiRegionConfigurationReplicaKey>
    multiRegionKeyType string
    多区域密钥的类型。
    primaryKey KeyMultiRegionConfigurationPrimaryKey
    主多区域键的事务识别号和区域 ID。
    replicaKeys KeyMultiRegionConfigurationReplicaKey[]
    multiRegionKeyType String
    多区域密钥的类型。
    primaryKey Property Map
    主多区域键的事务识别号和区域 ID。
    replicaKeys List<Property Map>

    KeyMultiRegionConfigurationPrimaryKey, KeyMultiRegionConfigurationPrimaryKeyArgs

    Region string
    多区域密钥的区域 ID。
    Trn string
    多区域密钥的 TRN。
    Region string
    多区域密钥的区域 ID。
    Trn string
    多区域密钥的 TRN。
    region String
    多区域密钥的区域 ID。
    trn String
    多区域密钥的 TRN。
    region string
    多区域密钥的区域 ID。
    trn string
    多区域密钥的 TRN。
    region str
    多区域密钥的区域 ID。
    trn str
    多区域密钥的 TRN。
    region String
    多区域密钥的区域 ID。
    trn String
    多区域密钥的 TRN。

    KeyMultiRegionConfigurationReplicaKey, KeyMultiRegionConfigurationReplicaKeyArgs

    Region string
    多区域密钥的区域 ID。
    Trn string
    多区域密钥的转换。
    Region string
    多区域密钥的区域 ID。
    Trn string
    多区域密钥的转换。
    region String
    多区域密钥的区域 ID。
    trn String
    多区域密钥的转换。
    region string
    多区域密钥的区域 ID。
    trn string
    多区域密钥的转换。
    region str
    多区域密钥的区域 ID。
    trn str
    多区域密钥的转换。
    region String
    多区域密钥的区域 ID。
    trn String
    多区域密钥的转换。

    KeyTag, KeyTagArgs

    Key string
    KMS密钥的标签键
    Value string
    KMS密钥的标签值
    Key string
    KMS密钥的标签键
    Value string
    KMS密钥的标签值
    key String
    KMS密钥的标签键
    value String
    KMS密钥的标签值
    key string
    KMS密钥的标签键
    value string
    KMS密钥的标签值
    key str
    KMS密钥的标签键
    value str
    KMS密钥的标签值
    key String
    KMS密钥的标签键
    value String
    KMS密钥的标签值

    Import

    $ pulumi import bytepluscc:kms/key:Key example "keyring_name|key_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Meet Neo: Your AI Platform Teammate