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

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

カスタムリソースプロバイダーの応答フィールド

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

注記

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

ステータス

AWS CloudFormation で生成されたリクエストに応答して、カスタムリソースプロバイダーによって送信されるステータス値。

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

必須: はい

タイプ: 文字列

理由

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

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

タイプ: 文字列

PhysicalResourceId

この値は、カスタムリソースベンダーに固有の識別子である必要があり、サイズは最大 1 KB までです。値は空でない文字列でなければならず、同じリソースに対するすべての応答で同一である必要があります。

PhysicalResourceId に返された値は、カスタムリソース更新オペレーションを変更できます。返される値が同じであれば、通常の更新と見なされます。返された値が異なる場合には、AWS CloudFormation は新しい方が更新用のものであると認識し、古いリソースに削除リクエストを送信します。詳細については、「AWS::CloudFormation::CustomResource」を参照してください。

必須: はい

タイプ: 文字列

StackId

カスタムリソースを含むスタックを識別する Amazon リソースネーム (ARN)。この応答値は、リクエストから逐語的にコピーする必要があります。

必須: はい

タイプ: 文字列

RequestId

リクエストの一意の ID。この応答値は、リクエストから逐語的にコピーする必要があります。

必須: はい

タイプ: 文字列

LogicalResourceId

AWS CloudFormation テンプレートで開発者が選択したカスタムリソースの名前 (論理 ID)。この応答値は、リクエストから逐語的にコピーする必要があります。

必須: はい

タイプ: 文字列

NoEcho

オプション。Fn::GetAtt 関数を使用して取得したときに、カスタムリソースの出力をマスクするかどうかを示します。true に設定すると、テンプレートの Metadata セクションに格納されているものを除き、すべての戻り値がアスタリスク (*****) でマスクされる。AWS CloudFormation は、Metadata セクションに含まれる情報を変換、変更、または編集しません。デフォルト値は false です。

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

必須: いいえ

タイプ: ブール

[データ]

オプション。レスポンスで送信するカスタムリソースプロバイダー定義の名前と値のペア。ここで提供されている値には、Fn::GetAtt を使用してテンプレートの名前でアクセスできます。

重要

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

必須: いいえ

タイプ: JSON オブジェクト