ALIYUN::KMS::Secret类型用于创建凭据,并存入凭据的初始版本。

语法

{
  "Type": "ALIYUN::KMS::Secret",
  "Properties": {
    "VersionId": String,
    "SecretName": String,
    "Description": String,
    "SecretDataType": String,
    "SecretData": String,
    "VersionStages": List,
    "EncryptionKeyId": String,
    "RecoveryWindowInDays": Integer,
    "ForceDeleteWithoutRecovery": Boolean
  }
}

属性

属性名称类型必须允许更新描述约束
VersionIdString初始版本的版本号。凭据对象内版本号唯一。
SecretNameString凭据名称。
DescriptionString凭据的描述信息。
SecretDataTypeString凭据值类型。取值:
  • text
  • binary
SecretDataString新创建凭据的凭据值。凭据管家将其加密后,存入初始版本中。
VersionStagesList版本的状态标记。默认标记:ACSCurrent。

最多指定7个标记。

EncryptionKeyIdString用于加密保护凭据值的KMS主密钥的标识符。如果不指定,则凭据管家使用系统创建的密钥来加密保护凭据数据。
说明 KMS主密钥必须是对称密钥。
RecoveryWindowInDaysInteger按照可恢复的方式删除凭据,且指定可恢复的窗口。默认值:30。

单位:天。

ForceDeleteWithoutRecoveryBoolean是否强制删除凭据,且不允许恢复。取值范围:
  • true
  • false(默认值)

返回值

Fn::GetAtt

  • SecretName:凭据名称。
  • Arn:阿里云资源名称。

示例

  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      Secret:
        Type: ALIYUN::KMS::Secret
        Properties:
          VersionId: v1
          SecretName: TestSecret
          SecretData: DemoSecretData
          ForceDeleteWithoutRecovery: false
    Outputs: {}
  • JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "Secret": {
          "Type": "ALIYUN::KMS::Secret",
          "Properties": {
            "VersionId": "v1",
            "SecretName": "TestSecret",
            "SecretData": "DemoSecretData",
            "ForceDeleteWithoutRecovery": false
          }
        }
      },
      "Outputs": {
      }
    }