Skip to content

KeyProps

Properties for defining a Key.

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

Initializer 

import ros_cdk_kms
ros_cdk_kms.KeyProps(
  deletion_protection: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  dkms_instance_id: typing.Union[str, IResolvable] = None,
  enable: typing.Union[bool, IResolvable] = None,
  enable_automatic_rotation: typing.Union[bool, IResolvable] = None,
  key_spec: typing.Union[str, IResolvable] = None,
  key_usage: typing.Union[str, IResolvable] = None,
  pending_window_in_days: typing.Union[typing.Union[int, float], IResolvable] = None,
  policy: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  protection_level: typing.Union[str, IResolvable] = None,
  rotation_interval: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Specifies whether to enable the release protection feature for the key.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the CMK.
dkms_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dkmsInstanceId: The ID of the dedicated KMS instance.
enable typing.Union[bool, ros_cdk_core.IResolvable] Property enable: Specifies whether the key is enabled.
enable_automatic_rotation typing.Union[bool, ros_cdk_core.IResolvable] Property enableAutomaticRotation: Whether to enable automatic key rotation.
key_spec typing.Union[str, ros_cdk_core.IResolvable] Property keySpec: Key type.
key_usage typing.Union[str, ros_cdk_core.IResolvable] Property keyUsage: The usage of the CMK.
pending_window_in_days typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property pendingWindowInDays: The waiting period, specified in number of days.
policy typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property policy: The policy of key.
protection_level typing.Union[str, ros_cdk_core.IResolvable] Property protectionLevel: The protection level of the CMK to create.
rotation_interval typing.Union[str, ros_cdk_core.IResolvable] Property rotationInterval: The time period for automatic rotation.

deletion_protectionOptional 

deletion_protection: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionProtection: Specifies whether to enable the release protection feature for the key.

Default is false.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the CMK.

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

dkms_instance_idOptional 

dkms_instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dkmsInstanceId: The ID of the dedicated KMS instance.

enableOptional 

enable: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enable: Specifies whether the key is enabled.

Defaults to true.

enable_automatic_rotationOptional 

enable_automatic_rotation: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableAutomaticRotation: Whether to enable automatic key rotation.

Valid value: true/false (default)

key_specOptional 

key_spec: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property keySpec: Key type.

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

key_usageOptional 

key_usage: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

pending_window_in_daysOptional 

pending_window_in_days: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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 

policy: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property policy: The policy of key.

protection_levelOptional 

protection_level: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

rotation_intervalOptional 

rotation_interval: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.