pulumi-alicloud-kotlin/com.pulumi.alicloud.kms.kotlin/Key

Key

class Key : KotlinCustomResource

A kms key can help user to protect data security in the transmission process. For information about Alikms Key and how to use it, see What is Resource Alikms Key.

NOTE: Available since v1.85.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const key = new alicloud.kms.Key("key", {
    description: "Hello KMS",
    pendingWindowInDays: 7,
    status: "Enabled",
});

import pulumi
import pulumi_alicloud as alicloud
key = alicloud.kms.Key("key",
    description="Hello KMS",
    pending_window_in_days=7,
    status="Enabled")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
    var key = new AliCloud.Kms.Key("key", new()
    {
        Description = "Hello KMS",
        PendingWindowInDays = 7,
        Status = "Enabled",
    });
});

package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/kms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kms.NewKey(ctx, "key", &kms.KeyArgs{
			Description:         pulumi.String("Hello KMS"),
			PendingWindowInDays: pulumi.Int(7),
			Status:              pulumi.String("Enabled"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.kms.Key;
import com.pulumi.alicloud.kms.KeyArgs;
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 key = new Key("key", KeyArgs.builder()
            .description("Hello KMS")
            .pendingWindowInDays("7")
            .status("Enabled")
            .build());
    }
}

resources:
  key:
    type: alicloud:kms:Key
    properties:
      description: Hello KMS
      pendingWindowInDays: '7'
      status: Enabled

Import

Alikms key can be imported using the id, e.g.

$ pulumi import alicloud:kms/key:Key example <id>

Properties

arn

val arn: Output<String>

The Alicloud Resource Name (ARN) of the key.

automaticRotation

val automaticRotation: Output<String>

Specifies whether to enable automatic key rotation. Default value: Disabled. Valid values:

creationDate

val creationDate: Output<String>

The date and time when the CMK was created. The time is displayed in UTC.

creator

val creator: Output<String>

The creator of the CMK.

deleteDate

val deleteDate: Output<String>

The scheduled date to delete CMK. The time is displayed in UTC. This value is returned only when the KeyState value is PendingDeletion.

deletionWindowInDays

val ~~deletionWindowInDays~~: Output<Int>

Field deletion_window_in_days has been deprecated from provider version 1.85.0. New field pending_window_in_days instead.

description

val description: Output<String>?

The description of the CMK. The description can be 0 to 8,192 characters in length.

dkmsInstanceId

val dkmsInstanceId: Output<String>?

The instance ID of the exclusive KMS instance.

val id: Output<String>

isEnabled

val ~~isEnabled~~: Output<Boolean>?

Field is_enabled has been deprecated from provider version 1.85.0. New field status instead.

keySpec

val keySpec: Output<String>

The type of the CMK. Default value: Aliyun_AES_256. Valid values: Aliyun_AES_256, Aliyun_AES_128, Aliyun_AES_192, Aliyun_SM4, RSA_2048, RSA_3072, EC_P256, EC_P256K, EC_SM2. Note: The default type of the CMK is Aliyun_AES_256. Only Dedicated KMS supports Aliyun_AES_128 and Aliyun_AES_192.

keyState

val ~~keyState~~: Output<String>

Field key_state has been deprecated from provider version 1.123.1. New field status instead.

keyUsage

val keyUsage: Output<String>

The usage of the CMK. Default value: ENCRYPT/DECRYPT. Valid values:

lastRotationDate

val lastRotationDate: Output<String>

The date and time the last rotation was performed. The time is displayed in UTC.

materialExpireTime

val materialExpireTime: Output<String>

The time and date the key material for the CMK expires. The time is displayed in UTC. If the value is empty, the key material for the CMK does not expire.

nextRotationDate

val nextRotationDate: Output<String>

The time the next rotation is scheduled for execution.

origin

val origin: Output<String>

The source of key material. Default value: Aliyun_KMS. Valid values:

pendingWindowInDays

val pendingWindowInDays: Output<Int>

The number of days before the CMK is deleted. During this period, the CMK is in the PendingDeletion state. After this period ends, you cannot cancel the deletion. Valid values: 7 to 366. Unit: days. NOTE: From version 1.184.0, pending_window_in_days can be set to 366.

primaryKeyVersion

val primaryKeyVersion: Output<String>

The ID of the current primary key version of the symmetric CMK.

protectionLevel

val protectionLevel: Output<String>?

The protection level of the CMK. Default value: SOFTWARE. Valid values:

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

rotationInterval

val rotationInterval: Output<String>?

The interval for automatic key rotation. Specify the value in the integerunit format. The following units are supported: d (day), h (hour), m (minute), and s (second). For example, you can use either 7d or 604800s to specify a seven-day interval. The interval can range from 7 days to 730 days. NOTE: It is Required when automatic_rotation = "Enabled"

status

val status: Output<String>

The status of CMK. Default value: Enabled. Valid Values: