作成
テンプレート開発者がカスタムリソースを含むスタックを作成すると、CloudFormation は RequestType を Create に設定して custom resource provider にリクエストを送信します。このリクエストは、特にカスタムリソースの作成中に発生します。
カスタムリソースとその仕組みの概要については、「カスタムリソース」を参照してください。
リクエスト
作成リクエストには、以下のフィールドが含まれています。
RequestType-
Create. RequestId-
リクエストの一意の ID。
ResponseURL-
応答 URL は、custom resource provider から AWS CloudFormation への応答を受信する署名済み S3 バケットを識別します。
ResourceType-
CloudFormation テンプレート内のカスタムリソースに対し、テンプレートのデベロッパーが選択したリソースタイプ。カスタムリソースタイプの名前は、60 文字までの長さで指定できます。また、英数字や記号
_@-を含めることができます。 LogicalResourceId-
AWS CloudFormation テンプレートで開発者が選択したカスタムリソースの名前 (論理 ID)。
StackId-
カスタムリソースを含むスタックを識別する Amazon リソースネーム (ARN)。
ResourceProperties-
このフィールドにはテンプレート開発者によって送信された
Propertiesオブジェクトの内容が含まれます。その内容は、custom resource provider によって定義されます。
例
{
"RequestType" : "Create",
"RequestId" : "unique id for this create request",
"ResponseURL" : "pre-signed-url-for-create-response",
"ResourceType" : "Custom::MyCustomResourceType",
"LogicalResourceId" : "name of resource in template",
"StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10",
"ResourceProperties" : {
"key1" : "string",
"key2" : [ "list" ],
"key3" : { "key4" : "map" }
}
}レスポンス
成功
作成リクエストが成功したときは、次のフィールドを含んだレスポンスを Amazon S3 バケットに送信する必要があります。
Status-
SUCCESSを指定してください。 RequestId-
リクエストの一意の ID。この応答値は、リクエストから逐語的にコピーする必要があります。
LogicalResourceId-
AWS CloudFormation テンプレートで開発者が選択したカスタムリソースの名前 (論理 ID)。この応答値は、リクエストから逐語的にコピーする必要があります。
StackId-
カスタムリソースを含むスタックを識別する Amazon リソースネーム (ARN)。この応答値は、リクエストから逐語的にコピーする必要があります。
PhysicalResourceId-
この値は、カスタムリソースベンダーに固有の識別子である必要があり、サイズは最大 1 KB までです。値は空でない文字列でなければならず、同じリソースに対するすべての応答で同一である必要があります。
PhysicalResourceIdに返された値は、カスタムリソース更新オペレーションを変更できます。返される値が同じであれば、通常の更新と見なされます。返された値が異なる場合には、AWS CloudFormation は新しい方が更新用のものであると認識し、古いリソースに削除リクエストを送信します。詳細については、「AWS::CloudFormation::CustomResource」を参照してください。 NoEcho-
オプション。
Fn::GetAtt関数を使用して取得したときに、カスタムリソースの出力をマスクするかどうかを示します。trueに設定すると、テンプレートのMetadataセクションに格納されているものを除き、すべての戻り値がアスタリスク (*****) でマスクされる。AWS CloudFormation は、Metadataセクションに含まれる情報を変換、変更、または編集しません。デフォルト値はfalseです。NoEchoを使用して機密情報をマスクする方法、および動的なパラメータを使用してシークレットを管理する方法の詳細については、「テンプレートに認証情報を埋め込まない」ベストプラクティスを参照してください。 Data-
オプション。レスポンスで送信するカスタムリソースプロバイダー定義の名前と値のペア。ここで提供されている値には、
Fn::GetAttを使用してテンプレートの名前でアクセスできます。重要
名前と値のペアに機密情報が含まれている場合は、
NoEchoフィールドを使用して、カスタムリソースの出力をマスクします。それ以外の場合は、プロパティ値 (DescribeStackEventsなど) を表示する API を通じて値が表示されます。
例
{
"Status" : "SUCCESS",
"RequestId" : "unique id for this create request (copied from request)",
"LogicalResourceId" : "name of resource in template (copied from request)",
"StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10 (copied from request)",
"PhysicalResourceId" : "required vendor-defined physical id that is unique for that vendor",
"Data" : {
"keyThatCanBeUsedInGetAtt1" : "data for key 1",
"keyThatCanBeUsedInGetAtt2" : "data for key 2"
}
}[失敗]
作成リクエストが失敗したときは、次のフィールドを含んだレスポンスを S3 バケットに送信する必要があります。
Status-
FAILEDを指定してください。 Reason-
失敗応答の理由を説明します。
RequestId-
リクエストの一意の ID。この応答値は、リクエストから逐語的にコピーする必要があります。
LogicalResourceId-
AWS CloudFormation テンプレートで開発者が選択したカスタムリソースの名前 (論理 ID)。この応答値は、リクエストから逐語的にコピーする必要があります。
StackId-
カスタムリソースを含むスタックを識別する Amazon リソースネーム (ARN)。この応答値は、リクエストから逐語的にコピーする必要があります。
PhysicalResourceId-
この値は、カスタムリソースベンダーに固有の識別子である必要があり、サイズは最大 1 KB までです。値は空でない文字列でなければならず、同じリソースに対するすべての応答で同一である必要があります。
PhysicalResourceIdに返された値は、カスタムリソース更新オペレーションを変更できます。返される値が同じであれば、通常の更新と見なされます。返された値が異なる場合には、AWS CloudFormation は新しい方が更新用のものであると認識し、古いリソースに削除リクエストを送信します。詳細については、「AWS::CloudFormation::CustomResource」を参照してください。
例
{
"Status" : "FAILED",
"Reason" : "Required failure reason string",
"RequestId" : "unique id for this create request (copied from request)",
"LogicalResourceId" : "name of resource in template (copied from request)",
"StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10 (copied from request)",
"PhysicalResourceId" : "required vendor-defined physical id that is unique for that vendor"
}