SecretProps
Properties for defining a Secret
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kms-secret
Initializer
using AlibabaCloud.SDK.ROS.CDK.Kms;
new SecretProps {
object SecretData,
object SecretName,
object VersionId,
object Description = null,
object DkmsInstanceId = null,
object EnableAutomaticRotation = null,
object EncryptionKeyId = null,
object ExtendedConfig = null,
object ForceDeleteWithoutRecovery = null,
object RecoveryWindowInDays = null,
object RotationInterval = null,
object SecretDataType = null,
object SecretType = null,
object VersionStages = null
};
Properties
Name | Type | Description |
---|---|---|
SecretData |
object |
Property secretData: The value of the secret that you want to create. |
SecretName |
object |
Property secretName: The name of the secret. |
VersionId |
object |
Property versionId: The version number of the initial version. |
Description |
object |
Property description: The description of the secret. |
DkmsInstanceId |
object |
Property dkmsInstanceId: The ID of the dedicated KMS instance. |
EnableAutomaticRotation |
object |
Property enableAutomaticRotation: Specifies whether to enable automatic rotation. |
EncryptionKeyId |
object |
Property encryptionKeyId: The ID of the KMS CMK that is used to encrypt the secret value. |
ExtendedConfig |
object |
Property extendedConfig: The extended configuration of the secret. |
ForceDeleteWithoutRecovery |
object |
Property forceDeleteWithoutRecovery: Specifies whether to forcibly delete the secret. |
RecoveryWindowInDays |
object |
Property recoveryWindowInDays: Specifies the recovery period of the secret if you do not forcibly delete it. |
RotationInterval |
object |
Property rotationInterval: The interval for automatic rotation. |
SecretDataType |
object |
Property secretDataType: The type of the secret value. |
SecretType |
object |
Property secretType: The type of the secret. |
VersionStages |
object |
Property versionStages: The stage labels that mark the secret version. |
SecretData
Required
public object SecretData { get; set; }
- Type: object
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 object SecretName { get; set; }
- Type: object
Property secretName: The name of the secret.
VersionId
Required
public object VersionId { get; set; }
- Type: object
Property versionId: The version number of the initial version.
Version numbers are unique in each secret object.
Description
Optional
public object Description { get; set; }
- Type: object
Property description: The description of the secret.
DkmsInstanceId
Optional
public object DkmsInstanceId { get; set; }
- Type: object
Property dkmsInstanceId: The ID of the dedicated KMS instance.
EnableAutomaticRotation
Optional
public object EnableAutomaticRotation { get; set; }
- Type: object
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 object EncryptionKeyId { get; set; }
- Type: object
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 object ExtendedConfig { get; set; }
- Type: object
Property extendedConfig: The extended configuration of the secret.
This parameter specifies the properties of the secret of the specific type.
ForceDeleteWithoutRecovery
Optional
public object ForceDeleteWithoutRecovery { get; set; }
- Type: object
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 object RecoveryWindowInDays { get; set; }
- Type: object
Property recoveryWindowInDays: Specifies the recovery period of the secret if you do not forcibly delete it.
Default value: 30
RotationInterval
Optional
public object RotationInterval { get; set; }
- Type: object
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 object SecretDataType { get; set; }
- Type: object
Property secretDataType: The type of the secret value.
Valid values: text (default value) binary
SecretType
Optional
public object SecretType { get; set; }
- Type: object
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 object VersionStages { get; set; }
- Type: object
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".