SecretProps

Properties for defining a Secret.

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

Initializer

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

Properties

Name	Type	Description
secretData	string | @alicloud/ros-cdk-core.IResolvable	Property secretData: The value of the secret that you want to create.
secretName	string | @alicloud/ros-cdk-core.IResolvable	Property secretName: The name of the secret.
versionId	string | @alicloud/ros-cdk-core.IResolvable	Property versionId: The version number of the initial version.
description	string | @alicloud/ros-cdk-core.IResolvable	Property description: The description of the secret.
dkmsInstanceId	string | @alicloud/ros-cdk-core.IResolvable	Property dkmsInstanceId: The ID of the dedicated KMS instance.
enableAutomaticRotation	boolean | @alicloud/ros-cdk-core.IResolvable	Property enableAutomaticRotation: Specifies whether to enable automatic rotation.
encryptionKeyId	string | @alicloud/ros-cdk-core.IResolvable	Property encryptionKeyId: The ID of the KMS CMK that is used to encrypt the secret value.
extendedConfig	@alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}	Property extendedConfig: The extended configuration of the secret.
forceDeleteWithoutRecovery	boolean | @alicloud/ros-cdk-core.IResolvable	Property forceDeleteWithoutRecovery: Specifies whether to forcibly delete the secret.
recoveryWindowInDays	number | @alicloud/ros-cdk-core.IResolvable	Property recoveryWindowInDays: Specifies the recovery period of the secret if you do not forcibly delete it.
rotationInterval	string | @alicloud/ros-cdk-core.IResolvable	Property rotationInterval: The interval for automatic rotation.
secretDataType	string | @alicloud/ros-cdk-core.IResolvable	Property secretDataType: The type of the secret value.
secretType	string | @alicloud/ros-cdk-core.IResolvable	Property secretType: The type of the secret.
versionStages	@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]	Property versionStages: The stage labels that mark the secret version.

---

secretData^Required

public readonly secretData: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property secretData: The value of the secret that you want to create.

Secrets Manager encrypts the secret value and stores it in the initial version.

---

secretName^Required

public readonly secretName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property secretName: The name of the secret.

---

versionId^Required

public readonly versionId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property versionId: The version number of the initial version.

Version numbers are unique in each secret object.

---

description^Optional

public readonly description: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the secret.

---

dkmsInstanceId^Optional

public readonly dkmsInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dkmsInstanceId: The ID of the dedicated KMS instance.

---

enableAutomaticRotation^Optional

public readonly enableAutomaticRotation: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableAutomaticRotation: Specifies whether to enable automatic rotation.

Valid values: true: specifies to enable automatic rotation. false: specifies to disable automatic rotation. This is the default value.

---

encryptionKeyId^Optional

public readonly encryptionKeyId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property encryptionKeyId: The ID of the KMS CMK that is used to encrypt the secret value.

If you do not specify this parameter, Secrets Manager automatically creates an encryption key to encrypt the secret. Note The KMS CMK must be a symmetric key.

---

extendedConfig^Optional

public readonly extendedConfig: IResolvable | {[ key: string ]: any};

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

Property extendedConfig: The extended configuration of the secret.

This parameter specifies the properties of the secret of the specific type.

---

forceDeleteWithoutRecovery^Optional

public readonly forceDeleteWithoutRecovery: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property forceDeleteWithoutRecovery: Specifies whether to forcibly delete the secret.

If this parameter is set to true, the secret cannot be recovered. Valid values: true false (default value)

---

recoveryWindowInDays^Optional

public readonly recoveryWindowInDays: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property recoveryWindowInDays: Specifies the recovery period of the secret if you do not forcibly delete it.

Default value: 30

---

rotationInterval^Optional

public readonly rotationInterval: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property rotationInterval: The interval for automatic rotation.

Valid values: 6 hours to 8,760 hours (365 days). The value is in the integer[unit] format. The unit can be d (day), h (hour), m (minute), or s (second). For example, both 7d and 604800s indicate a seven-day interval.

---

secretDataType^Optional

public readonly secretDataType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property secretDataType: The type of the secret value.

Valid values: text (default value) binary

---

secretType^Optional

public readonly secretType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property secretType: The type of the secret.

Valid values: Generic: specifies a generic secret. Rds: specifies a managed ApsaraDB RDS secret. RAMCredentials: specifies a managed RAM secret. ECS: specifies a managed ECS secret.

---

versionStages^Optional

public readonly versionStages: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property versionStages: The stage labels that mark the secret version.

ACSCurrent will be marked as DefaultIf you do not specify it, Secrets Manager marks it with "ACSCurrent".

---