カスタムリソースを使用してカスタムプロビジョニングロジックを作成する

カスタムリソースプロバイダーは、CloudFormation からのリクエストを処理し、カスタムリソースに対してアクションを実行する方法を決定するロジックを書き込みます。

カスタムリソースプロバイダーは、CloudFormation がリクエストを送信できる Amazon SNS トピックまたは Lambda 関数を作成します。Amazon SNS トピックまたは Lambda 関数は、スタックを作成するリージョンと同じリージョンに存在する必要があります。

カスタムリソースプロバイダーは、Amazon SNS トピック ARN または Lambda 関数 ARN をテンプレート開発者に提供します。

テンプレート開発者は、CloudFormation テンプレートでカスタムリソースを定義します。これには、サービストークンと入力データパラメータが含まれます。サービストークンや入力データの構造は custom resource provider によって定義されます。サービストークンは Amazon SNS トピック ARN または Lambda 関数 ARN を指定し、常に必須ですが、入力データはカスタムリソースに応じてオプションです。

CloudFormation は、指定されたサービストークンにリクエストを送信します。このリクエストには、 にリクエストタイプやカスタムリソースが応答を送信する宛先の Amazon Simple Storage Service の署名付き URL などの情報が含まれています。リクエストに含まれている情報の詳細については、「カスタムリソースリクエストオブジェクト」を参照してください。

以下のサンプルデータは、CloudFormation が Create リクエストに含める内容を示しています。　この例では、ResourceProperties は CloudFormation が Lambda 関数へ送信するカスタムペイロードの作成を許可します。

{
   "RequestType" : "Create",
   "ResponseURL" : "http://pre-signed-S3-url-for-response",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10",
   "RequestId" : "unique id for this create request",
   "ResourceType" : "Custom::TestResource",
   "LogicalResourceId" : "MyTestResource",
   "ResourceProperties" : {
      "Name" : "Value",
      "List" : [ "1", "2", "3" ]
   }
}

custom resource provider は CloudFormation のリクエストを処理し、SUCCESS または FAILED の応答を署名付き URL に返します。custom resource provider は、応答を JSON 形式のファイルで提供し、それを署名付き S3 URL にアップロードします。詳細については、「Amazon Simple Storage Service ユーザーガイド」の「Uploading objects using pre-signed URLs」(署名付き URL を使用したオブジェクトのアップロード) を参照してください。

その応答について、custom resource provider には template developer がアクセスできる名前と値のペアも含まれている場合があります。たとえば、応答には要求が成功した場合は出力データ、要求が失敗した場合はエラーメッセージが含まれることがあります。応答の詳細については、「カスタムリソースの応答オブジェクト」を参照してください。

custom resource provider には要求をリッスンして応答する責任があります。例えば、Amazon SNS 通知の場合、custom resource provider は特定のトピック ARN に送信される通知をリッスンして応答する必要があります。CloudFormation は、事前署名済みの URL の場所で応答を待機してリッスンします。

次のサンプルデータは、カスタムリソースの応答に含まれる可能性がある情報を示します。

{
   "Status" : "SUCCESS",
   "PhysicalResourceId" : "TestResource1",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/mystack/5b918d10-cd98-11ea-90d5-0a9cd3354c10",
   "RequestId" : "unique id for this create request",
   "LogicalResourceId" : "MyTestResource",
   "Data" : {
      "OutputName1" : "Value1",
      "OutputName2" : "Value2",
   }
}

SUCCESS 応答を取得した後、CloudFormation はスタックオペレーションを続けます。FAILED 応答が返されるか、応答が返されない場合、操作は失敗します。カスタムリソースからの出力データは署名付き URL の場所に保存されます。template developer は Fn::GetAtt 関数を使用してそのデータを取得できます。