AWS Lambda
開発者ガイド

AWS Lambda を AWS CloudFormation に使用する

AWS CloudFormation テンプレートでは、Lambda 関数をカスタムリソースのターゲットとして指定できます。パラメータの処理にカスタムリソースを使用したり、設定値を取得したり、スタックのライフサイクルイベント中に他の AWS のサービスを呼び出します。

次の例は、テンプレートの別の場所で定義される関数を呼び出します。

例 – カスタムリソースの定義

Resources: primerinvoke: Type: AWS::CloudFormation::CustomResource Version: "1.0" Properties: ServiceToken: !GetAtt primer.Arn FunctionName: !Ref randomerror

サービストークンは、スタックの作成、更新あるいは削除時に AWS CloudFormation が呼び出す関数の Amazon リソースネーム (ARN) です。また、FunctionName のように AWS CloudFormation が関数にそのまま渡す追加のプロパティを含めることができます。

AWS CloudFormation では、コールバック URL を含むイベントで非同期的に Lambda 関数を呼び出します。

例 – AWS CloudFormation メッセージイベント

{ "RequestType": "Create", "ServiceToken": "arn:aws:lambda:us-east-2:123456789012:function:lambda-error-processor-primer-14ROR2T3JKU66", "ResponseURL": "https://cloudformation-custom-resource-response-useast2.s3-us-east-2.amazonaws.com/arn%3Aaws%3Acloudformation%3Aus-east-2%3A123456789012%3Astack/lambda-error-processor/1134083a-2608-1e91-9897-022501a2c456%7Cprimerinvoke%7C5d478078-13e9-baf0-464a-7ef285ecc786?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1555451971&Signature=28UijZePE5I4dvukKQqM%2F9Rf1o4%3D", "StackId": "arn:aws:cloudformation:us-east-2:123456789012:stack/lambda-error-processor/1134083a-2608-1e91-9897-022501a2c456", "RequestId": "5d478078-13e9-baf0-464a-7ef285ecc786", "LogicalResourceId": "primerinvoke", "ResourceType": "AWS::CloudFormation::CustomResource", "ResourceProperties": { "ServiceToken": "arn:aws:lambda:us-east-2:123456789012:function:lambda-error-processor-primer-14ROR2T3JKU66", "FunctionName": "lambda-error-processor-randomerror-ZWUC391MQAJK" } }

関数は、成功あるいは失敗を示すコールバック URL にレスポンスを返す処理を行います完全なレスポンスの構文については、「カスタムリソースの応答オブジェクト」を参照してください。

例 – AWS CloudFormation カスタムリソース応答

{ "Status": "SUCCESS", "PhysicalResourceId": "2019/04/18/[$LATEST]b3d1bfc65f19ec610654e4d9b9de47a0", "StackId": "arn:aws:cloudformation:us-east-2:123456789012:stack/lambda-error-processor/1134083a-2608-1e91-9897-022501a2c456", "RequestId": "5d478078-13e9-baf0-464a-7ef285ecc786", "LogicalResourceId": "primerinvoke" }

AWS CloudFormation は応答の送信を処理する cfn-response という名前のライブラリを提供します。テンプレートで関数を定義する場合、ライブラリを名前で使用できます。AWS CloudFormation はこのライブラリを作成する関数のデプロイパッケージに追加します。

次の関数例では、2 番目の関数を呼び出しています。呼び出しが成功すると、この関数は成功レスポンスを AWS CloudFormation に送信し、スタックの更新が継続します。

例 – カスタムリソース関数

Resources: primer: Type: AWS::Serverless::Function Properties: Handler: index.handler Runtime: nodejs8.10 InlineCode: | var aws = require('aws-sdk'); var response = require('cfn-response'); exports.handler = function(event, context) { // For Delete requests, immediately send a SUCCESS response. if (event.RequestType == "Delete") { response.send(event, context, "SUCCESS"); return; } var responseStatus = "FAILED"; var responseData = {}; var functionName = event.ResourceProperties.FunctionName var lambda = new aws.Lambda(); lambda.invoke({ FunctionName: functionName }, function(err, invokeResult) { if (err) { responseData = {Error: "Invoke call failed"}; console.log(responseData.Error + ":\n", err); } else responseStatus = "SUCCESS"; response.send(event, context, responseStatus, responseData); }); }; Description: Invoke a function to create a log stream. MemorySize: 128 Timeout: 8 Role: !GetAtt role.Arn Tracing: Active

カスタムリソースが呼び出す関数がテンプレートで定義されていない場合、AWS CloudFormation ユーザーガイド の cfn-response Module から cfn-response のリソースコードを取得できます。

カスタムリソースを使用するサンプルアプリケーションで、依存する別のリソースの前に関数のロググループが作成されることを確実にするには、「AWS Lambda の Error Processor サンプルアプリケーション」を参照してください。

カスタムリソースについてさらに詳しくは、『AWS CloudFormation ユーザーガイド』の「カスタムリソース」を参照してください。