カスタムリソースの応答オブジェクト - AWS CloudFormation

カスタムリソースの応答オブジェクト

Custom Resource Provider 応答フィールド

以下に示すのは、カスタムリソースプロバイダーが JSON ファイルを署名付き URL に送信するときに含めるプロパティです。署名付き URL を使用したオブジェクトのアップロードについての詳細は、Amazon Simple Storage Service 開発者ガイド の関連するトピックを参照してください。

注記

レスポンス本文の合計サイズは 4096 バイトを超えることはできません。

ステータス

AWS CloudFormation が生成したリクエストに応じて、custom resource provider が送信したステータス値。

SUCCESS または FAILED である必要があります。

Required: Yes

Type: String

Reason

失敗応答の理由を説明します。

Required: StatusFAILED の場合は必須です。それ以外の場合はオプションです。

Type: String

PhysicalResourceId

この値は、カスタムリソースベンダーに一意な識別子である必要があり、サイズは最大 1 KB まで可能です。値は空以外の文字列で、同じリソースのすべての応答で同一である必要があります。

Required: Yes

Type: String

StackId

カスタムリソースを含むスタックを識別する Amazon Resource Name (ARN)。 このレスポンス値は、リクエストからそのままコピーする必要があります。

Required: Yes

Type: String

RequestId

リクエストの一意の ID。 このレスポンス値は、リクエストからそのままコピーする必要があります。

Required: Yes

Type: String

LogicalResourceId

AWS CloudFormation テンプレートで、template developer によって選択されたカスタムリソースの名前 (論理 ID)。 このレスポンス値は、リクエストからそのままコピーする必要があります。

Required: Yes

Type: String

NoEcho

省略可能。Fn::GetAtt 関数を使用してカスタムリソースの出力を取得したときに、それをマスクするかどうかを示します。true に設定した場合、返されるすべての値はアスタリスク (*****) でマスクされます。デフォルト値は false です。

NoEcho を使用して機密情報をマスクする方法の詳細については、「テンプレートに認証情報を埋め込まない」ベストプラクティスを参照してください。

Required: No

Type: Boolean

データ

省略可能。応答で送信される、custom resource providerによって定義された名前と値のペア。ここで指定する値には、Fn::GetAtt を使用して、テンプレート内の名前でアクセスできます。

重要

名前と値のペアに重要な情報が含まれる場合、NoEcho フィールドを使用してカスタムリソースの出力をマスクします。それ以外の場合、値はプロパティ値 (DescribeStackEvents など) を示す API を通じて表示されます。

Required: No

Type: JSON object