Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. kms
  5. Key
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.kms.Key

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage kms key

    Example Usage

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

const fooKeyring = new volcengine.kms.Keyring("fooKeyring", {
    keyringName: "tf-test",
    description: "tf-test",
    projectName: "default",
});
const fooKey = new volcengine.kms.Key("fooKey", {
    keyringName: fooKeyring.keyringName,
    keyName: "mrk-tf-key-mod",
    description: "tf test key-mod",
    tags: [{
        key: "tfkey3",
        value: "tfvalue3",
    }],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_keyring = volcengine.kms.Keyring("fooKeyring",
    keyring_name="tf-test",
    description="tf-test",
    project_name="default")
foo_key = volcengine.kms.Key("fooKey",
    keyring_name=foo_keyring.keyring_name,
    key_name="mrk-tf-key-mod",
    description="tf test key-mod",
    tags=[volcengine.kms.KeyTagArgs(
        key="tfkey3",
        value="tfvalue3",
    )])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooKeyring, err := kms.NewKeyring(ctx, "fooKeyring", &kms.KeyringArgs{
			KeyringName: pulumi.String("tf-test"),
			Description: pulumi.String("tf-test"),
			ProjectName: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_, err = kms.NewKey(ctx, "fooKey", &kms.KeyArgs{
			KeyringName: fooKeyring.KeyringName,
			KeyName:     pulumi.String("mrk-tf-key-mod"),
			Description: pulumi.String("tf test key-mod"),
			Tags: kms.KeyTagArray{
				&kms.KeyTagArgs{
					Key:   pulumi.String("tfkey3"),
					Value: pulumi.String("tfvalue3"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooKeyring = new Volcengine.Kms.Keyring("fooKeyring", new()
    {
        KeyringName = "tf-test",
        Description = "tf-test",
        ProjectName = "default",
    });

    var fooKey = new Volcengine.Kms.Key("fooKey", new()
    {
        KeyringName = fooKeyring.KeyringName,
        KeyName = "mrk-tf-key-mod",
        Description = "tf test key-mod",
        Tags = new[]
        {
            new Volcengine.Kms.Inputs.KeyTagArgs
            {
                Key = "tfkey3",
                Value = "tfvalue3",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.kms.Keyring;
import com.pulumi.volcengine.kms.KeyringArgs;
import com.pulumi.volcengine.kms.Key;
import com.pulumi.volcengine.kms.KeyArgs;
import com.pulumi.volcengine.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 fooKeyring = new Keyring("fooKeyring", KeyringArgs.builder()        
            .keyringName("tf-test")
            .description("tf-test")
            .projectName("default")
            .build());

        var fooKey = new Key("fooKey", KeyArgs.builder()        
            .keyringName(fooKeyring.keyringName())
            .keyName("mrk-tf-key-mod")
            .description("tf test key-mod")
            .tags(KeyTagArgs.builder()
                .key("tfkey3")
                .value("tfvalue3")
                .build())
            .build());

    }
}

    resources:
  fooKeyring:
    type: volcengine:kms:Keyring
    properties:
      keyringName: tf-test
      description: tf-test
      projectName: default
  fooKey:
    type: volcengine:kms:Key
    properties:
      keyringName: ${fooKeyring.keyringName}
      keyName: mrk-tf-key-mod
      description: tf test key-mod
      tags:
        - key: tfkey3
          value: tfvalue3

    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,
        pending_window_in_days: Optional[int] = 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: volcengine: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 Volcengine.Kms.Key("keyResource", new()
{
    KeyName = "string",
    KeyringName = "string",
    Description = "string",
    KeySpec = "string",
    KeyUsage = "string",
    MultiRegion = false,
    Origin = "string",
    PendingWindowInDays = 0,
    ProtectionLevel = "string",
    RotateState = "string",
    Tags = new[]
    {
        new Volcengine.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"),
	PendingWindowInDays: pulumi.Int(0),
	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")
    .pendingWindowInDays(0)
    .protectionLevel("string")
    .rotateState("string")
    .tags(KeyTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

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

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

    type: volcengine:kms:Key
properties:
    description: string
    keyName: string
    keySpec: string
    keyUsage: string
    keyringName: string
    multiRegion: false
    origin: string
    pendingWindowInDays: 0
    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
    The name of the CMK.
    KeyringName string
    The name of the keyring.
    Description string
    The description of the key.
    KeySpec string
    The type of the keys.
    KeyUsage string
    The usage of the key.
    MultiRegion bool
    Whether it is the master key of the Multi-region type.
    Origin string
    The origin of the key.
    PendingWindowInDays int
    The pre-deletion cycle of the key.
    ProtectionLevel string
    The protection level of the key.
    RotateState string
    The rotation state of the key.
    Tags List<KeyTag>
    Tags.
    KeyName string
    The name of the CMK.
    KeyringName string
    The name of the keyring.
    Description string
    The description of the key.
    KeySpec string
    The type of the keys.
    KeyUsage string
    The usage of the key.
    MultiRegion bool
    Whether it is the master key of the Multi-region type.
    Origin string
    The origin of the key.
    PendingWindowInDays int
    The pre-deletion cycle of the key.
    ProtectionLevel string
    The protection level of the key.
    RotateState string
    The rotation state of the key.
    Tags []KeyTagArgs
    Tags.
    keyName String
    The name of the CMK.
    keyringName String
    The name of the keyring.
    description String
    The description of the key.
    keySpec String
    The type of the keys.
    keyUsage String
    The usage of the key.
    multiRegion Boolean
    Whether it is the master key of the Multi-region type.
    origin String
    The origin of the key.
    pendingWindowInDays Integer
    The pre-deletion cycle of the key.
    protectionLevel String
    The protection level of the key.
    rotateState String
    The rotation state of the key.
    tags List<KeyTag>
    Tags.
    keyName string
    The name of the CMK.
    keyringName string
    The name of the keyring.
    description string
    The description of the key.
    keySpec string
    The type of the keys.
    keyUsage string
    The usage of the key.
    multiRegion boolean
    Whether it is the master key of the Multi-region type.
    origin string
    The origin of the key.
    pendingWindowInDays number
    The pre-deletion cycle of the key.
    protectionLevel string
    The protection level of the key.
    rotateState string
    The rotation state of the key.
    tags KeyTag[]
    Tags.
    key_name str
    The name of the CMK.
    keyring_name str
    The name of the keyring.
    description str
    The description of the key.
    key_spec str
    The type of the keys.
    key_usage str
    The usage of the key.
    multi_region bool
    Whether it is the master key of the Multi-region type.
    origin str
    The origin of the key.
    pending_window_in_days int
    The pre-deletion cycle of the key.
    protection_level str
    The protection level of the key.
    rotate_state str
    The rotation state of the key.
    tags Sequence[KeyTagArgs]
    Tags.
    keyName String
    The name of the CMK.
    keyringName String
    The name of the keyring.
    description String
    The description of the key.
    keySpec String
    The type of the keys.
    keyUsage String
    The usage of the key.
    multiRegion Boolean
    Whether it is the master key of the Multi-region type.
    origin String
    The origin of the key.
    pendingWindowInDays Number
    The pre-deletion cycle of the key.
    protectionLevel String
    The protection level of the key.
    rotateState String
    The rotation state of the key.
    tags List<Property Map>
    Tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Key resource produces the following output properties:

    CreationDate int
    The date when the keyring was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyMaterialExpireTime string
    The time when the key material will expire.
    LastRotationTime string
    The last time the key was rotated.
    MultiRegionConfiguration KeyMultiRegionConfiguration
    The configuration of Multi-region key.
    RotationState string
    The rotation configuration of the key.
    ScheduleDeleteTime string
    The time when the key will be deleted.
    ScheduleRotationTime string
    The next time the key will be rotated.
    State string
    The state of the key.
    Trn string
    The name of the resource.
    UpdateDate int
    The date when the keyring was updated.
    CreationDate int
    The date when the keyring was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyMaterialExpireTime string
    The time when the key material will expire.
    LastRotationTime string
    The last time the key was rotated.
    MultiRegionConfiguration KeyMultiRegionConfiguration
    The configuration of Multi-region key.
    RotationState string
    The rotation configuration of the key.
    ScheduleDeleteTime string
    The time when the key will be deleted.
    ScheduleRotationTime string
    The next time the key will be rotated.
    State string
    The state of the key.
    Trn string
    The name of the resource.
    UpdateDate int
    The date when the keyring was updated.
    creationDate Integer
    The date when the keyring was created.
    id String
    The provider-assigned unique ID for this managed resource.
    keyMaterialExpireTime String
    The time when the key material will expire.
    lastRotationTime String
    The last time the key was rotated.
    multiRegionConfiguration KeyMultiRegionConfiguration
    The configuration of Multi-region key.
    rotationState String
    The rotation configuration of the key.
    scheduleDeleteTime String
    The time when the key will be deleted.
    scheduleRotationTime String
    The next time the key will be rotated.
    state String
    The state of the key.
    trn String
    The name of the resource.
    updateDate Integer
    The date when the keyring was updated.
    creationDate number
    The date when the keyring was created.
    id string
    The provider-assigned unique ID for this managed resource.
    keyMaterialExpireTime string
    The time when the key material will expire.
    lastRotationTime string
    The last time the key was rotated.
    multiRegionConfiguration KeyMultiRegionConfiguration
    The configuration of Multi-region key.
    rotationState string
    The rotation configuration of the key.
    scheduleDeleteTime string
    The time when the key will be deleted.
    scheduleRotationTime string
    The next time the key will be rotated.
    state string
    The state of the key.
    trn string
    The name of the resource.
    updateDate number
    The date when the keyring was updated.
    creation_date int
    The date when the keyring was created.
    id str
    The provider-assigned unique ID for this managed resource.
    key_material_expire_time str
    The time when the key material will expire.
    last_rotation_time str
    The last time the key was rotated.
    multi_region_configuration KeyMultiRegionConfiguration
    The configuration of Multi-region key.
    rotation_state str
    The rotation configuration of the key.
    schedule_delete_time str
    The time when the key will be deleted.
    schedule_rotation_time str
    The next time the key will be rotated.
    state str
    The state of the key.
    trn str
    The name of the resource.
    update_date int
    The date when the keyring was updated.
    creationDate Number
    The date when the keyring was created.
    id String
    The provider-assigned unique ID for this managed resource.
    keyMaterialExpireTime String
    The time when the key material will expire.
    lastRotationTime String
    The last time the key was rotated.
    multiRegionConfiguration Property Map
    The configuration of Multi-region key.
    rotationState String
    The rotation configuration of the key.
    scheduleDeleteTime String
    The time when the key will be deleted.
    scheduleRotationTime String
    The next time the key will be rotated.
    state String
    The state of the key.
    trn String
    The name of the resource.
    updateDate Number
    The date when the keyring was updated.

    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,
        creation_date: Optional[int] = None,
        description: Optional[str] = None,
        key_material_expire_time: Optional[str] = None,
        key_name: Optional[str] = None,
        key_spec: 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,
        pending_window_in_days: Optional[int] = None,
        protection_level: Optional[str] = None,
        rotate_state: Optional[str] = None,
        rotation_state: Optional[str] = None,
        schedule_delete_time: Optional[str] = None,
        schedule_rotation_time: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Sequence[KeyTagArgs]] = None,
        trn: Optional[str] = None,
        update_date: 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: volcengine: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:
    CreationDate int
    The date when the keyring was created.
    Description string
    The description of the key.
    KeyMaterialExpireTime string
    The time when the key material will expire.
    KeyName string
    The name of the CMK.
    KeySpec string
    The type of the keys.
    KeyUsage string
    The usage of the key.
    KeyringName string
    The name of the keyring.
    LastRotationTime string
    The last time the key was rotated.
    MultiRegion bool
    Whether it is the master key of the Multi-region type.
    MultiRegionConfiguration KeyMultiRegionConfiguration
    The configuration of Multi-region key.
    Origin string
    The origin of the key.
    PendingWindowInDays int
    The pre-deletion cycle of the key.
    ProtectionLevel string
    The protection level of the key.
    RotateState string
    The rotation state of the key.
    RotationState string
    The rotation configuration of the key.
    ScheduleDeleteTime string
    The time when the key will be deleted.
    ScheduleRotationTime string
    The next time the key will be rotated.
    State string
    The state of the key.
    Tags List<KeyTag>
    Tags.
    Trn string
    The name of the resource.
    UpdateDate int
    The date when the keyring was updated.
    CreationDate int
    The date when the keyring was created.
    Description string
    The description of the key.
    KeyMaterialExpireTime string
    The time when the key material will expire.
    KeyName string
    The name of the CMK.
    KeySpec string
    The type of the keys.
    KeyUsage string
    The usage of the key.
    KeyringName string
    The name of the keyring.
    LastRotationTime string
    The last time the key was rotated.
    MultiRegion bool
    Whether it is the master key of the Multi-region type.
    MultiRegionConfiguration KeyMultiRegionConfigurationArgs
    The configuration of Multi-region key.
    Origin string
    The origin of the key.
    PendingWindowInDays int
    The pre-deletion cycle of the key.
    ProtectionLevel string
    The protection level of the key.
    RotateState string
    The rotation state of the key.
    RotationState string
    The rotation configuration of the key.
    ScheduleDeleteTime string
    The time when the key will be deleted.
    ScheduleRotationTime string
    The next time the key will be rotated.
    State string
    The state of the key.
    Tags []KeyTagArgs
    Tags.
    Trn string
    The name of the resource.
    UpdateDate int
    The date when the keyring was updated.
    creationDate Integer
    The date when the keyring was created.
    description String
    The description of the key.
    keyMaterialExpireTime String
    The time when the key material will expire.
    keyName String
    The name of the CMK.
    keySpec String
    The type of the keys.
    keyUsage String
    The usage of the key.
    keyringName String
    The name of the keyring.
    lastRotationTime String
    The last time the key was rotated.
    multiRegion Boolean
    Whether it is the master key of the Multi-region type.
    multiRegionConfiguration KeyMultiRegionConfiguration
    The configuration of Multi-region key.
    origin String
    The origin of the key.
    pendingWindowInDays Integer
    The pre-deletion cycle of the key.
    protectionLevel String
    The protection level of the key.
    rotateState String
    The rotation state of the key.
    rotationState String
    The rotation configuration of the key.
    scheduleDeleteTime String
    The time when the key will be deleted.
    scheduleRotationTime String
    The next time the key will be rotated.
    state String
    The state of the key.
    tags List<KeyTag>
    Tags.
    trn String
    The name of the resource.
    updateDate Integer
    The date when the keyring was updated.
    creationDate number
    The date when the keyring was created.
    description string
    The description of the key.
    keyMaterialExpireTime string
    The time when the key material will expire.
    keyName string
    The name of the CMK.
    keySpec string
    The type of the keys.
    keyUsage string
    The usage of the key.
    keyringName string
    The name of the keyring.
    lastRotationTime string
    The last time the key was rotated.
    multiRegion boolean
    Whether it is the master key of the Multi-region type.
    multiRegionConfiguration KeyMultiRegionConfiguration
    The configuration of Multi-region key.
    origin string
    The origin of the key.
    pendingWindowInDays number
    The pre-deletion cycle of the key.
    protectionLevel string
    The protection level of the key.
    rotateState string
    The rotation state of the key.
    rotationState string
    The rotation configuration of the key.
    scheduleDeleteTime string
    The time when the key will be deleted.
    scheduleRotationTime string
    The next time the key will be rotated.
    state string
    The state of the key.
    tags KeyTag[]
    Tags.
    trn string
    The name of the resource.
    updateDate number
    The date when the keyring was updated.
    creation_date int
    The date when the keyring was created.
    description str
    The description of the key.
    key_material_expire_time str
    The time when the key material will expire.
    key_name str
    The name of the CMK.
    key_spec str
    The type of the keys.
    key_usage str
    The usage of the key.
    keyring_name str
    The name of the keyring.
    last_rotation_time str
    The last time the key was rotated.
    multi_region bool
    Whether it is the master key of the Multi-region type.
    multi_region_configuration KeyMultiRegionConfigurationArgs
    The configuration of Multi-region key.
    origin str
    The origin of the key.
    pending_window_in_days int
    The pre-deletion cycle of the key.
    protection_level str
    The protection level of the key.
    rotate_state str
    The rotation state of the key.
    rotation_state str
    The rotation configuration of the key.
    schedule_delete_time str
    The time when the key will be deleted.
    schedule_rotation_time str
    The next time the key will be rotated.
    state str
    The state of the key.
    tags Sequence[KeyTagArgs]
    Tags.
    trn str
    The name of the resource.
    update_date int
    The date when the keyring was updated.
    creationDate Number
    The date when the keyring was created.
    description String
    The description of the key.
    keyMaterialExpireTime String
    The time when the key material will expire.
    keyName String
    The name of the CMK.
    keySpec String
    The type of the keys.
    keyUsage String
    The usage of the key.
    keyringName String
    The name of the keyring.
    lastRotationTime String
    The last time the key was rotated.
    multiRegion Boolean
    Whether it is the master key of the Multi-region type.
    multiRegionConfiguration Property Map
    The configuration of Multi-region key.
    origin String
    The origin of the key.
    pendingWindowInDays Number
    The pre-deletion cycle of the key.
    protectionLevel String
    The protection level of the key.
    rotateState String
    The rotation state of the key.
    rotationState String
    The rotation configuration of the key.
    scheduleDeleteTime String
    The time when the key will be deleted.
    scheduleRotationTime String
    The next time the key will be rotated.
    state String
    The state of the key.
    tags List<Property Map>
    Tags.
    trn String
    The name of the resource.
    updateDate Number
    The date when the keyring was updated.

    Supporting Types

    KeyMultiRegionConfiguration, KeyMultiRegionConfigurationArgs

    MultiRegionKeyType string
    The type of the multi-region key.
    PrimaryKey KeyMultiRegionConfigurationPrimaryKey
    Trn and region id of the primary multi-region key.
    ReplicaKeys List<KeyMultiRegionConfigurationReplicaKey>
    Trn and region id of replica multi-region keys.
    MultiRegionKeyType string
    The type of the multi-region key.
    PrimaryKey KeyMultiRegionConfigurationPrimaryKey
    Trn and region id of the primary multi-region key.
    ReplicaKeys []KeyMultiRegionConfigurationReplicaKey
    Trn and region id of replica multi-region keys.
    multiRegionKeyType String
    The type of the multi-region key.
    primaryKey KeyMultiRegionConfigurationPrimaryKey
    Trn and region id of the primary multi-region key.
    replicaKeys List<KeyMultiRegionConfigurationReplicaKey>
    Trn and region id of replica multi-region keys.
    multiRegionKeyType string
    The type of the multi-region key.
    primaryKey KeyMultiRegionConfigurationPrimaryKey
    Trn and region id of the primary multi-region key.
    replicaKeys KeyMultiRegionConfigurationReplicaKey[]
    Trn and region id of replica multi-region keys.
    multi_region_key_type str
    The type of the multi-region key.
    primary_key KeyMultiRegionConfigurationPrimaryKey
    Trn and region id of the primary multi-region key.
    replica_keys Sequence[KeyMultiRegionConfigurationReplicaKey]
    Trn and region id of replica multi-region keys.
    multiRegionKeyType String
    The type of the multi-region key.
    primaryKey Property Map
    Trn and region id of the primary multi-region key.
    replicaKeys List<Property Map>
    Trn and region id of replica multi-region keys.

    KeyMultiRegionConfigurationPrimaryKey, KeyMultiRegionConfigurationPrimaryKeyArgs

    Region string
    The region id of multi-region key.
    Trn string
    The name of the resource.
    Region string
    The region id of multi-region key.
    Trn string
    The name of the resource.
    region String
    The region id of multi-region key.
    trn String
    The name of the resource.
    region string
    The region id of multi-region key.
    trn string
    The name of the resource.
    region str
    The region id of multi-region key.
    trn str
    The name of the resource.
    region String
    The region id of multi-region key.
    trn String
    The name of the resource.

    KeyMultiRegionConfigurationReplicaKey, KeyMultiRegionConfigurationReplicaKeyArgs

    Region string
    The region id of multi-region key.
    Trn string
    The name of the resource.
    Region string
    The region id of multi-region key.
    Trn string
    The name of the resource.
    region String
    The region id of multi-region key.
    trn String
    The name of the resource.
    region string
    The region id of multi-region key.
    trn string
    The name of the resource.
    region str
    The region id of multi-region key.
    trn str
    The name of the resource.
    region String
    The region id of multi-region key.
    trn String
    The name of the resource.

    KeyTag, KeyTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Import

    KmsKey can be imported using the id, e.g.

    $ pulumi import volcengine:kms/key:Key default resource_id

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
    volcengine/pulumi-volcengine