KeyProps

Properties for defining a Key.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Kms;
new KeyProps {
    object Description = null,
    object DkmsInstanceId = null,
    object Enable = null,
    object EnableAutomaticRotation = null,
    object KeySpec = null,
    object KeyUsage = null,
    object PendingWindowInDays = null,
    object Policy = null,
    object ProtectionLevel = null,
    object RotationInterval = null
};

Properties

Name	Type	Description
Description	object	Property description: The description of the CMK.
DkmsInstanceId	object	Property dkmsInstanceId: The ID of the dedicated KMS instance.
Enable	object	Property enable: Specifies whether the key is enabled.
EnableAutomaticRotation	object	Property enableAutomaticRotation: Whether to enable automatic key rotation.
KeySpec	object	Property keySpec: Key type.
KeyUsage	object	Property keyUsage: The usage of the CMK.
PendingWindowInDays	object	Property pendingWindowInDays: The waiting period, specified in number of days.
Policy	object	Property policy: The policy of key.
ProtectionLevel	object	Property protectionLevel: The protection level of the CMK to create.
RotationInterval	object	Property rotationInterval: The time period for automatic rotation.

---

Description^Optional

public object Description { get; set; }

• Type: object

Property description: The description of the CMK.

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

---

DkmsInstanceId^Optional

public object DkmsInstanceId { get; set; }

• Type: object

Property dkmsInstanceId: The ID of the dedicated KMS instance.

---

Enable^Optional

public object Enable { get; set; }

• Type: object

Property enable: Specifies whether the key is enabled.

Defaults to true.

---

EnableAutomaticRotation^Optional

public object EnableAutomaticRotation { get; set; }

• Type: object

Property enableAutomaticRotation: Whether to enable automatic key rotation.

Valid value: true/false (default)

---

KeySpec^Optional

public object KeySpec { get; set; }

• Type: object

Property keySpec: Key type.

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

---

KeyUsage^Optional

public object KeyUsage { get; set; }

• Type: object

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.

---

PendingWindowInDays^Optional

public object PendingWindowInDays { get; set; }

• Type: object

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.

---

Policy^Optional

public object Policy { get; set; }

• Type: object

Property policy: The policy of key.

---

ProtectionLevel^Optional

public object ProtectionLevel { get; set; }

• Type: object

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.

---

RotationInterval^Optional

public object RotationInterval { get; set; }

• Type: object

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.

---