Toolkit AWS SAM を使用した の操作 AWS

1. [AWS Explorer] で [Lambda] ノードを右クリックしてコンテキストメニューを開き、[Create Lambda SAM Application] (Lambda SAM アプリケーションの作成) を選択します。

   注記

   または、[AWS: Explorer] のリストからメニューアイコンを選択し、[Create Lambda SAM Application] (Lambda SAM アプリケーションの作成) を選択します。

2. SAM アプリケーションのランタイムを選択します。この例では、［nodejs12.x］を選択します。

   注記

   「(Image)」を含むランタイムの 1 つを選択した場合、アプリケーションのパッケージタイプは Image です。「(Image)」を含まないランタイムの 1 つを選択した場合、アプリケーションは Zip タイプです。Image および Zip パッケージタイプの違いの詳細については、AWS Lambda デベロッパーガイドの「Lambda デプロイパッケージ」を参照してください。

3. サーバーレスアプリケーションに以下のいずれかのテンプレートを選択します。

   • AWS SAM Hello World: 従来の「Hello World」メッセージを返す Lambda 関数を含む基本的なテンプレート。

   • AWS Step Functions サンプルアプリ: 株式取引ワークフローを実行するサンプルアプリケーション。ステップ関数は、関与する Lambda 関数の相互作用をオーケストレートします。

4. 新しいプロジェクトの場所を選択します。既存のワークスペースフォルダがある場合は、これを選択できます。それ以外の場合は、別のフォルダを参照して選択します。[Select a different folder] (別のフォルダを選択) を選択すると、ダイアログボックスが表示され、フォルダの場所を選択できます。

5. 新しいアプリケーションの名前を入力します。この例では my-sam-app-nodejs を使用します。Enter キーを押すと、 AWS Toolkit はプロジェクトの作成に少し時間がかかります。

SAM テンプレートを使用してサーバーレスアプリケーションを実行およびデバッグ

1. サーバーレスアプリケーションを構成するアプリケーションファイルを表示するには、［環境 ］ウィンドウに移動します。

2. アプリケーションフォルダ (例:my-sample-app) でtemplate.yaml ファイルを開きます。

3. template.yaml で、[Edit Launch Configuration] (起動設定の編集) を選択します。

   新しいエディタに表示されるlaunch.jsonファイルは、デフォルト属性があるデバッグ設定を提供します。

4. 次の設定プロパティの値を編集または確認します。

   • "name" – 読みやすい名前を入力して、[実行] ビューの [設定] ドロップダウンフィールドに表示します。

   • "target" – 値が "template" であることを確認します。これにより、SAM テンプレートがデバッグセッションのエントリポイントになります。

   • "templatePath" – template.yaml ファイルに相対パスまたは絶対パスを入力。

   • "logicalId" – 名前が SAM テンプレートの [Resources] (リソース) セクションに指定されている名前と一致することを確認します。この場合はタイプ AWS::Serverless::Function の HelloWorldFunction です。

   launch.json ファイル内のこれらと他の入力に関する詳細は、「サーバーレスアプリケーションのデバッグ用設定オプション」を参照してください。

5. デバッグ設定に問題がなければ、launch.json を保存します。次に、RUN の横の緑色の［play] (再生) ボタンを選択してデバッグを開始します。

   注記

   SAM アプリケーションの実行に失敗した場合は、［出力］ウィンドウをチェックして、Docker イメージが構築されていないためにエラーが発生しているかどうかを確認します。環境でディスク容量の解放が必要になる場合があります。

   詳細については、「AWS Cloud9 環境に十分なディスク容量がないため、 AWS Toolkit で SAM アプリケーションをローカルで実行中にエラーが発生しました」を参照してください。

   デバッグセッションを開始すると、[DEBUG CONSOLE] (デバッグコンソール) パネルにデバッグ出力が表示され、Lambda 関数から返された値が表示されます。SAM アプリケーションをデバッグする場合、AWS ツールキットを [Output] (出力) パネルの [Output] (出力) チャネルとして選択します。

   注記

   Windows ユーザーの場合、このプロセス中に Docker マウントエラーが表示されたら、[Docker Settings] (Docker 設定) で共有ドライブの認証情報を 更新する必要があります。Docker マウントエラーは次のように表示されます。

   Fetching lambci/lambda:nodejs10.x Docker container image......
   2019-07-12 13:36:58 Mounting C:\Users\<username>\AppData\Local\Temp\ ... as /var/task:ro,delegated inside runtime container
   Traceback (most recent call last):
   ...requests.exceptions.HTTPError: 500 Server Error: Internal Server Error ...

サーバーレスアプリケーションをアプリケーションコードから直接実行およびデバッグ

1. サーバーレスアプリケーションのファイルを表示するには、エディタの横にあるフォルダアイコンを選択して、アプリケーションフォルダに移動します。

2. アプリケーションフォルダ (my-sample-app など) で、関数フォルダ (この例では hello-world) を展開し、app.js ファイルを開きます。

3. 対象の Lambda ハンドラー関数を識別するインラインアクションで、Add Debug Configuration を選択します。[Add debug configuration] (デバッグ設定の追加) オプションが表示されない場合は、コードレンズを有効にする必要があります。コードレンズを有効にするには、「AWS Toolkit コードレンズの有効化 」を参照してください。

   

4. SAM アプリケーションを実行するランタイムを選択します。

5. launch.json ファイルのエディターでは、次の設定プロパティの値を編集または確認します。

   • "name" – 分かりやすい名前を入力します。

   • "target" – 値が "code" で、Lambda 関数ハンドラを直接呼び出せることを確認します。

   • "lambdaHandler" – 関数を呼び出すために Lambda が呼び出すコード内のメソッドの名前を入力します。例えば、JavaScript のアプリケーションでは、デフォルトは app.lambdaHandler です。

   • "projectRoot" – Lambda 関数を含むアプリケーションファイルにパスを入力します。

   • "runtime" – Lambda 実行環境の有効なランタイム ("nodejs.12x" など) を入力または確認します。

   • "payload" – 以下のいずれかのオプションを選択して、Lambda 関数に入力として提供するイベントペイロードを定義します。

     • "json": イベントペイロードを定義する JSON 形式のキーバリューペア。

     • "path": イベントペイロードとして使用されるファイルへのパス。

6. デバッグ設定が満足なものであれば、［RUN］の横の緑の再生矢印を選択して、デバッグをスタートします。

   デバッグセッションが開始すると、[DEBUG CONSOLE] (デバッグコンソール) パネルにデバッグ出力が表示され、Lambda 関数から返された値が表示されます。SAM アプリケーションをデバッグする場合、AWS ツールキットを [Output] (出力) パネルの [Output] (出力) チャネルとして選択します。

   注記

   エラーメッセージに Docker が記載されている場合は、この注記を参照してください。

ローカル API Gateway リソースを実行およびデバッグ

1. 以下のいずれかのアプローチを選択し、 AWS SAM API Gateway リソース用の起動設定を作成します。

   • オプション 1: AWS SAM プロジェクトのハンドラーソースコード (特に .js、.cs、または .py ファイル) にアクセスし、Lambda ハンドラーにカーソルを合わせて、[Add debug configuration] (デバッグ設定の追加) を選択します。[Add debug configuration] (デバッグ設定の追加) オプションが表示されない場合は、コードレンズを有効にします。コードレンズを有効にするには、「AWS Toolkit コードレンズの有効化 」を参照してください。次に、メニューで API イベントとマークされた項目を選択します。

   • オプション 2 launch.json を編集して、次の構文を使用して新しい起動設定を作成します。

     {
         "type": "aws-sam",
         "request": "direct-invoke",
         "name": "myConfig",
         "invokeTarget": {
             "target": "api",
             "templatePath": "n12/template.yaml",
             "logicalId": "HelloWorldFunction"
         },
         "api": {
             "path": "/hello",
             "httpMethod": "post",
             "payload": {
                 "json": {}
             }
         }, 
         "sam": {},
         "aws": {}
     }
                             

2. [Run] (実行) ボタンの横のドロップダウンメニューで、起動設定を選択します (上の例では myConfig という名前です)。

3. (オプション) Lambda プロジェクトコードにブレークポイントを追加します。

4. 緑の「再生」ボタンの横にある［Run (実行)］ボタンを選択します。

5. 出力ペインで、結果を表示します。

1. [AWS Explorer] ウィンドウで、[Lambda] ノードを右クリックしてコンテキストメニューを開き、[SAM アプリケーションを同期] を選択します。

2. デプロイ先の AWS リージョン を選択します。

3. デプロイに使用する template.yaml ファイルを選択します。

4. このデプロイで使用できる Amazon S3 バケットの名前を入力します。バケットは、デプロイ先のリージョンにある必要があります。

   警告

   Amazon S3 バケット名は、Amazon S3 内のどの既存バケット名とも重複しないグローバルに一意な名前である必要があります。次の例に示す名前に一意の識別子を追加するか、別の名前を選択します。

5. サーバーレスアプリケーションに、パッケージタイプの Image を伴う関数が含まれているのであれば、このデプロイで使用できる Amazon ECR リポジトリの名前を入力します。リポジトリは、デプロイ先のリージョンにある必要があります。

6. デプロイしたスタックの名前 (新しいスタック名または既存のスタック名) を入力します。

7. コンソールの［AWS ツールキット］タブ上のデプロイの成功を確認します。

   エラーが発生すると、右下にメッセージが表示されます。

   この場合は、［AWS ツールキット］タブのテキストで詳細をチェックします。以下に示しているのは、エラーの詳細の例です。

   Error with child process: Unable to upload artifact HelloWorldFunction referenced by CodeUri parameter of HelloWorldFunction resource.
   S3 Bucket does not exist. Execute the command to create a new bucket
   aws s3 mb s3://pbart-my-sam-app-bucket
   An error occurred while deploying a SAM Application. Check the logs for more information by running the "View AWS Toolkit Logs" command from the Command Palette.

   この例では、Amazon S3 バケットが存在しないため、エラーが発生しています。