KeyProps

Properties for defining a Key.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkkms"
&alicloudroscdkkms.KeyProps {
    DeletionProtection: interface{},
    Description: interface{},
    DkmsInstanceId: interface{},
    Enable: interface{},
    EnableAutomaticRotation: interface{},
    KeySpec: interface{},
    KeyUsage: interface{},
    PendingWindowInDays: interface{},
    Policy: interface{},
    ProtectionLevel: interface{},
    RotationInterval: interface{},
}

Properties

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

---

DeletionProtection^Optional

DeletionProtection interface{}

• Type: interface{}

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

Default is false.

---

Description^Optional

Description interface{}

• Type: interface{}

Property description: The description of the CMK.

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

---

DkmsInstanceId^Optional

DkmsInstanceId interface{}

• Type: interface{}

Property dkmsInstanceId: The ID of the dedicated KMS instance.

---

Enable^Optional

Enable interface{}

• Type: interface{}

Property enable: Specifies whether the key is enabled.

Defaults to true.

---

EnableAutomaticRotation^Optional

EnableAutomaticRotation interface{}

• Type: interface{}

Property enableAutomaticRotation: Whether to enable automatic key rotation.

Valid value: true/false (default)

---

KeySpec^Optional

KeySpec interface{}

• Type: interface{}

Property keySpec: Key type.

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

---

KeyUsage^Optional

KeyUsage interface{}

• Type: interface{}

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

PendingWindowInDays interface{}

• Type: interface{}

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

Policy interface{}

• Type: interface{}

Property policy: The policy of key.

---

ProtectionLevel^Optional

ProtectionLevel interface{}

• Type: interface{}

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

RotationInterval interface{}

• Type: interface{}

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.

---