自訂資源回應物件 - AWS CloudFormation

自訂資源回應物件

本主題說明 CloudFormation 自訂資源的回應物件屬性。

有關自訂資源的簡介及其運作方式,請參閱 使用自訂資源建立自訂佈建邏輯

自訂資源提供者回應欄位

以下是自訂資源提供者將 JSON 檔案傳送到預先簽章的 URL 時所包含的屬性。如需有關使用預簽章 URL 上傳物件的詳細資訊,請參閱《Amazon Simple Storage Service 使用者指南》中的使用預簽章的 URL 上傳物件

注意

回應內文的總大小不能超過 4096 個位元組。

Status

自訂資源提供者為回應 CloudFormation 產生的請求而傳送的狀態值。

必須為 SUCCESSFAILED

必要:是

類型:String

Reason

描述失敗回應的原因。

必要:如果 StatusFAILED,則為必要。否則為選用。

類型:String

PhysicalResourceId

此值應為自訂資源廠商的唯一識別碼,且大小上限為 1 KB。此值必須是非空白字串,並且對於相同資源的所有回應必須完全相同。

傳回的 PhysicalResourceId 值可以變更自訂資源更新操作。如果傳回的值相同,則視為正常更新。若傳回的值不同,CloudFormation 會將該更新視為替代,並傳送刪除請求給舊資源。如需更多詳細資訊,請參閱 AWS::CloudFormation::CustomResource

必要:是

類型:String

StackId

識別包含自訂資源之堆疊的 Amazon Resource Name (ARN)。此回應值應從請求中逐字複製。

必要:是

類型:String

RequestId

請求的唯一 ID。此回應值應從請求中逐字複製。

必要:是

類型:String

LogicalResourceId

CloudFormation 範本內由範本開發人員選擇之自訂資源的名稱 (邏輯 ID)。此回應值應從請求中逐字複製。

必要:是

類型:String

NoEcho

選用。指示使用 Fn::GetAtt 函數擷取自訂資源時是否要遮罩其輸出。如果設定為 true,傳回的所有值都會以星號 (*****) 遮罩,除了那些存放在範本 Metadata 區段的值。CloudFormation 不會轉換、修改或修訂任何您包含在 Metadata 區段中的值。預設值為 false

如需使用 NoEcho 遮罩敏感資訊的詳細資訊,請參閱請勿在您的範本中內嵌憑證最佳實務。

必要:否

類型:布林值

Data

選用。要與回應一起傳送的自訂資源提供者定義之名稱值對。您可以在模板中透過 Fn::GetAtt 依名稱存取此處提供的值。

重要

如果名稱值對包含敏感資訊,您應該使用 NoEcho 欄位來遮罩自訂資源的輸出。否則,這些值可透過表示屬性值 (例如 DescribeStackEvents) 的 API 可見。

必要:否

類型:JSON 物件