ALIYUN::KMS::Secret资源类型参考-资源编排-阿里云

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,
    "SecretType": String,
    "EnableAutomaticRotation": Boolean,
    "RotationInterval": String,
    "ExtendedConfig": Map,
    "DKMSInstanceId": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
VersionId	String	是	是	初始版本的版本号。	凭据对象内版本号唯一。
SecretName	String	是	否	凭据名称。	无
Description	String	否	是	凭据的描述信息。	无
SecretDataType	String	否	否	凭据值类型。	取值： text binary
SecretData	String	是	是	新创建凭据的凭据值。凭据管家将其加密后，存入初始版本中。	无
VersionStages	List	否	是	版本的状态标记。	默认标记：ACSCurrent。最多指定7个标记。
EncryptionKeyId	String	否	否	用于加密保护凭据值的KMS主密钥的标识符。	如果不指定，则凭据管家使用系统创建的密钥来加密保护凭据数据。说明 KMS主密钥必须是对称密钥。
RecoveryWindowInDays	Integer	否	是	按照可恢复的方式删除凭据，且指定可恢复的窗口。	默认值：30。单位：天。
ForceDeleteWithoutRecovery	Boolean	否	是	是否强制删除凭据，且不允许恢复。	取值： true：强制删除凭据，且不允许恢复。 false（默认值）：非强制删除凭据，允许恢复。
SecretType	String	否	否	凭据类型。	取值： Generic：普通凭据。 Rds：托管RDS凭据。 RAMCredentials：托管RAM凭据。 ECS：托管ECS凭据。
EnableAutomaticRotation	Boolean	否	否	是否开启自动密钥轮转。	取值： true：开启自动密钥轮转。 false（默认值）：关闭自动密钥轮转。
RotationInterval	String	否	否	凭据自动轮转的周期。	格式为`integer[unit]`，其中`integer`表示时间长度，`unit`表示时间单位。`unit`取值：s（秒）。例如：7天的轮转周期为604800s。说明当自动轮转开启时，返回该参数。
ExtendedConfig	Map	否	否	凭据的拓展配置。	无
DKMSInstanceId	String	否	否	专属KMS的实例ID。	无

返回值

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": {
  }
}