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,
"Policy": Map,
"Tags": List
}
}屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
VersionId | String | 是 | 是 | 初始版本的版本號碼。 | 憑據對象內版本號碼唯一。 |
SecretName | String | 是 | 否 | 憑據名稱。 | 無 |
Description | String | 否 | 是 | 憑據的描述資訊。 | 無 |
SecretDataType | String | 否 | 否 | 憑據實值型別。 | 取值:
|
SecretData | String | 是 | 是 | 新建立憑據的憑據值。憑據管家將其加密後,存入初始版本中。 | 無 |
VersionStages | List | 否 | 是 | 版本的狀態標記。 | 預設標記:ACSCurrent。 最多指定7個標記。 |
EncryptionKeyId | String | 否 | 否 | 用於加密保護憑據值的KMS主要金鑰的標識符。 | 如果不指定,則憑據管家使用系統建立的密鑰來加密保護憑據資料。 說明 KMS主要金鑰必須是對稱金鑰。 |
RecoveryWindowInDays | Integer | 否 | 是 | 按照可恢複的方式刪除憑據,且指定可恢複的視窗。 | 預設值:30。 單位:天。 |
ForceDeleteWithoutRecovery | Boolean | 否 | 是 | 是否強制移除憑據,且不允許恢複。 | 取值:
|
SecretType | String | 否 | 否 | 憑據類型。 | 取值:
|
EnableAutomaticRotation | Boolean | 否 | 否 | 是否開啟自動密鑰輪轉。 | 取值:
|
RotationInterval | String | 否 | 否 | 憑據自動輪轉的周期。 | 格式為 說明 當自動輪轉開啟時,返回該參數。 |
ExtendedConfig | Map | 否 | 否 | 憑據的拓展配置。 | 無 |
Policy | Map | 否 | 否 | 密鑰策略。 | JSON格式。最大長度為32768個位元組。 關於密鑰策略的詳細介紹,請參見密鑰策略概述。不輸入該參數時,使用預設憑據策略。 密鑰策略內容包含:
密鑰策略格式為: |
Tags | List | 否 | 是 | 標籤。 | 最多支援添加20個標籤。 更多資訊,請參見Tags屬性。 |
DKMSInstanceId | String | 否 | 否 | 專屬KMS的執行個體ID。 | 無 |
Tags文法
"Tags": [
{
"Key": String,
"Value": String
}
] Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標籤鍵。 | 長度為1~128個字元,不能以 |
Value | String | 否 | 否 | 標籤值。 | 長度為0~128個字元,不能以 |
傳回值
Fn::GetAtt
SecretName:憑據名稱。
Arn:阿里雲資源名稱。
樣本
ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
Secret:
Type: ALIYUN::KMS::Secret
Properties:
VersionId: v1
SecretName: TestSecret
SecretData: DemoSecretData
ForceDeleteWithoutRecovery: false
Outputs: {}{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
},
"Resources": {
"Secret": {
"Type": "ALIYUN::KMS::Secret",
"Properties": {
"VersionId": "v1",
"SecretName": "TestSecret",
"SecretData": "DemoSecretData",
"ForceDeleteWithoutRecovery": false
}
}
},
"Outputs": {
}
}