Skip to content

KeyProps

Properties for defining a Key.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kms-key

Initializer 

import { KeyProps } from '@alicloud/ros-cdk-kms'
const keyProps: KeyProps = { ... }

Properties

Name Type Description
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the CMK.
dkmsInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dkmsInstanceId: The ID of the dedicated KMS instance.
enable boolean | @alicloud/ros-cdk-core.IResolvable Property enable: Specifies whether the key is enabled.
enableAutomaticRotation boolean | @alicloud/ros-cdk-core.IResolvable Property enableAutomaticRotation: Whether to enable automatic key rotation.
keySpec string | @alicloud/ros-cdk-core.IResolvable Property keySpec: Key type.
keyUsage string | @alicloud/ros-cdk-core.IResolvable Property keyUsage: The usage of the CMK.
pendingWindowInDays number | @alicloud/ros-cdk-core.IResolvable Property pendingWindowInDays: The waiting period, specified in number of days.
policy @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property policy: The policy of key.
protectionLevel string | @alicloud/ros-cdk-core.IResolvable Property protectionLevel: The protection level of the CMK to create.
rotationInterval string | @alicloud/ros-cdk-core.IResolvable Property rotationInterval: The time period for automatic rotation.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the CMK.

Length constraints: Minimum length of 0 characters. Maximum length of 8192 characters.

dkmsInstanceIdOptional 

public readonly dkmsInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dkmsInstanceId: The ID of the dedicated KMS instance.

enableOptional 

public readonly enable: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enable: Specifies whether the key is enabled.

Defaults to true.

enableAutomaticRotationOptional 

public readonly enableAutomaticRotation: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableAutomaticRotation: Whether to enable automatic key rotation.

Valid value: true\/false (default)

keySpecOptional 

public readonly keySpec: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property keySpec: Key type.

Valid value: Aliyun_AES_256\/Aliyun_SM4\/RSA_2048\/EC_P256\/EC_P256K\/EC_SM2

keyUsageOptional 

public readonly keyUsage: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property keyUsage: The usage of the CMK.

Valid values: ENCRYPT\/DECRYPT: encrypts or decrypts data. SIGN\/VERIFY: generates or verifies a digital signature. If the CMK supports signature verification, the default value is SIGN\/VERIFY. If the CMK does not support signature verification, the default value is ENCRYPT\/DECRYPT.

pendingWindowInDaysOptional 

public readonly pendingWindowInDays: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property pendingWindowInDays: The waiting period, specified in number of days.

During this period, you can cancel the CMK in PendingDeletion status. After the waiting period expires, you cannot cancel the deletion. The value must be between 7 and 366. Default value is 30.

policyOptional 

public readonly policy: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property policy: The policy of key.

protectionLevelOptional 

public readonly protectionLevel: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property protectionLevel: The protection level of the CMK to create.

Valid value: SOFTWARE and HSM. When this parameter is set to HSM: If the Origin parameter is set to Aliyun_KMS, the CMK is created in Managed HSM. If the Origin parameter is set to EXTERNAL, you can import external keys to Managed HSM.

rotationIntervalOptional 

public readonly rotationInterval: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property rotationInterval: The time period for automatic rotation.

The format is integer[unit], where integer represents the length of time and unit represents the time unit. The legal unit units are: d (day), h (hour), m (minute), s (second). 7d or 604800s both represent a 7-day cycle. Value: 7~730 days.