本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
自訂資源回應物件
本主題說明 CloudFormation 自訂資源的回應物件屬性。
如需自訂資源及其運作方式的簡介,請參閱使用自訂資源建立自訂佈建邏輯。
自訂資源提供者回應欄位
以下是自訂資源提供者在將JSON檔案傳送到預先簽章的 時包含的屬性URL。如需使用預先簽章 上傳物件的詳細資訊URLs,請參閱《Amazon Simple Storage Service 使用者指南》中的相關主題。
注意
回應內文的總大小不能超過 4096 個位元組。
Status
-
自訂資源提供者為回應 AWS CloudFormation產生的請求而傳送的狀態值。
必須為
SUCCESS
或FAILED
。必要:是
類型:字串
Reason
-
描述失敗回應的原因。
必要:如果
Status
為FAILED
,則為必要。否則為選用。類型:字串
PhysicalResourceId
此值應為自訂資源廠商的唯一識別碼,且大小上限為 1 KB。此值必須是非空白字串,並且對於相同資源的所有回應必須完全相同。
傳回的
PhysicalResourceId
值可以變更自訂資源更新操作。如果傳回的值相同,則視為正常更新。如果傳回的值不同, 會將更新 AWS CloudFormation 識別為取代,並將刪除請求傳送至舊資源。如需詳細資訊,請參閱AWS::CloudFormation::CustomResource
。必要:是
類型:字串
StackId
-
Amazon Resource Name (ARN),可識別包含自訂資源的堆疊。此回應值應從請求中逐字複製。
必要:是
類型:字串
RequestId
-
請求的唯一 ID。此回應值應從請求中逐字複製。
必要:是
類型:字串
LogicalResourceId
-
AWS CloudFormation 範本內由範本開發人員選擇之自訂資源的名稱 (邏輯 ID)。此回應值應從請求中逐字複製。
必要:是
類型:字串
NoEcho
-
選用。指示使用
Fn::GetAtt
函數擷取自訂資源時是否要遮罩其輸出。如果設為true
,則所有傳回的值都會以星號 (*****) 遮罩,但儲存在 範本Metadata
區段中的值除外。 AWS CloudFormation 不會轉換、修改或修改您在Metadata
區段中包含的任何資訊。預設值為false
。如需使用
NoEcho
遮罩敏感資訊的詳細資訊,請參閱請勿在您的範本中內嵌憑證最佳實務。必要:否
類型:布林值
Data
-
選用。要與回應一起傳送的自訂資源提供者定義之名稱值對。您可以在模板中透過
Fn::GetAtt
依名稱存取此處提供的值。重要
如果名稱值對包含敏感資訊,您應該使用
NoEcho
欄位來遮罩自訂資源的輸出。否則,這些值會透過APIs該表面屬性值 (例如DescribeStackEvents
) 顯示。必要:否
類型:JSON物件