Skip to content

SecretProps

Properties for defining a Secret.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkkms"
&alicloudroscdkkms.SecretProps {
    SecretData: interface{},
    SecretName: interface{},
    VersionId: interface{},
    Description: interface{},
    DkmsInstanceId: interface{},
    EnableAutomaticRotation: interface{},
    EncryptionKeyId: interface{},
    ExtendedConfig: interface{},
    ForceDeleteWithoutRecovery: interface{},
    RecoveryWindowInDays: interface{},
    RotationInterval: interface{},
    SecretDataType: interface{},
    SecretType: interface{},
    VersionStages: interface{},
}

Properties

Name Type Description
SecretData interface{} Property secretData: The value of the secret that you want to create.
SecretName interface{} Property secretName: The name of the secret.
VersionId interface{} Property versionId: The version number of the initial version.
Description interface{} Property description: The description of the secret.
DkmsInstanceId interface{} Property dkmsInstanceId: The ID of the dedicated KMS instance.
EnableAutomaticRotation interface{} Property enableAutomaticRotation: Specifies whether to enable automatic rotation.
EncryptionKeyId interface{} Property encryptionKeyId: The ID of the KMS CMK that is used to encrypt the secret value.
ExtendedConfig interface{} Property extendedConfig: The extended configuration of the secret.
ForceDeleteWithoutRecovery interface{} Property forceDeleteWithoutRecovery: Specifies whether to forcibly delete the secret.
RecoveryWindowInDays interface{} Property recoveryWindowInDays: Specifies the recovery period of the secret if you do not forcibly delete it.
RotationInterval interface{} Property rotationInterval: The interval for automatic rotation.
SecretDataType interface{} Property secretDataType: The type of the secret value.
SecretType interface{} Property secretType: The type of the secret.
VersionStages interface{} Property versionStages: The stage labels that mark the secret version.

SecretDataRequired

SecretData interface{}
  • Type: interface{}

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.


SecretNameRequired

SecretName interface{}
  • Type: interface{}

Property secretName: The name of the secret.


VersionIdRequired

VersionId interface{}
  • Type: interface{}

Property versionId: The version number of the initial version.

Version numbers are unique in each secret object.


DescriptionOptional

Description interface{}
  • Type: interface{}

Property description: The description of the secret.


DkmsInstanceIdOptional

DkmsInstanceId interface{}
  • Type: interface{}

Property dkmsInstanceId: The ID of the dedicated KMS instance.


EnableAutomaticRotationOptional

EnableAutomaticRotation interface{}
  • Type: interface{}

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.


EncryptionKeyIdOptional

EncryptionKeyId interface{}
  • Type: interface{}

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.


ExtendedConfigOptional

ExtendedConfig interface{}
  • Type: interface{}

Property extendedConfig: The extended configuration of the secret.

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


ForceDeleteWithoutRecoveryOptional

ForceDeleteWithoutRecovery interface{}
  • Type: interface{}

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)


RecoveryWindowInDaysOptional

RecoveryWindowInDays interface{}
  • Type: interface{}

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

Default value: 30


RotationIntervalOptional

RotationInterval interface{}
  • Type: interface{}

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.


SecretDataTypeOptional

SecretDataType interface{}
  • Type: interface{}

Property secretDataType: The type of the secret value.

Valid values: text (default value) binary


SecretTypeOptional

SecretType interface{}
  • Type: interface{}

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.


VersionStagesOptional

VersionStages interface{}
  • Type: interface{}

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".