AWS SAM 使用 AWS Toolkit

1. 在 AWS Explorer 中，開啟 (按一下右鍵) Lambda 節點的內容選單，然後選擇 Create Lambda SAM Application (建立 Lambda SAM 應用程式)。

   注意

   或者，您也可以在 AWS: Explorer 標題中選取選單圖示，然後選擇 Create Lambda SAM Application (建立 Lambda SAM 應用程式)。

2. 選擇您 SAM 應用程式的執行時間。在此範例中，請選擇 nodejs12.x。

   注意

   如果您選取了包含「(Image)」的執行時間，您的應用程式就是 Image 套件類型。如果您選取了不包含「(Image)」的執行時間，您的應用程式就是 Zip 類型。如需詳細了解 Image 和 Zip 套件類型的差異，請參閱 AWS Lambda 開發人員指南中的 Lambda 部署套件。

3. 為您的無伺服器應用程式選擇下列其中一個範本：

   • AWS SAM Hello World：具有 Lambda 函數的基本範本，會傳回傳統 "Hello World" 訊息。

   • AWS Step Functions 範例應用程式：執行股票交易工作流程的範例應用程式。Step Functions 會協調 Lambda 函數有參與的互動。

4. 您可以選擇新專案的位置。若已存在，您可以選取現有的工作空間資料夾。否則，請瀏覽其他資料夾。如果選擇 Select a different folder (選取其他資料夾)，畫面會顯示一個對話方塊，您可以從中選取資料夾位置。

5. 輸入新應用程式的名稱。在此範例中，使用 my-sam-app-nodejs。按 Enter 鍵後， AWS Toolkit 需要一些時間來建立專案。

如何使用 SAM 範本執行並除錯無伺服器應用程式

1. 若要檢視無伺服器應用程式內含的應用程式檔案，請前往 Environment (環境) 視窗。

2. 從應用程式資料夾 (例如 my-sample-app) 中開啟 template.yaml 檔案。

3. 針對 template.yaml，選取 Edit Launch Configuration (編輯啟動組態)。

   新的編輯器會顯示 launch.json 檔案，該檔案提供的除錯組態採用預設屬性。

4. 編輯或確認下列組態屬性的值：

   • "name" – 輸入方便識讀的名稱，讓它顯示在 Run (執行) 檢視的 Configuration (組態) 下拉式欄位中。

   • "target" – 確保該值是 "template"。如此一來，SAM 範本是除錯工作階段的進入點。

   • "templatePath" – 輸入 template.yaml 檔案的相對或絕對路徑。

   • "logicalId" – 確認名稱與 SAM 範本 Resources (資源) 區段中指定的名稱相符。在此例中，此名稱為 AWS::Serverless::Function 類型的 HelloWorldFunction。

   如需詳細了解 launch.json 檔案中的上述與其他項目，請參閱 除錯無伺服器應用程式的組態選項。

5. 如果您認為除錯組態沒有問題，請儲存 launch.json。接下來，選擇 RUN (執行) 旁邊的綠色「播放」按鈕，即可開始除錯。

   注意

   如果您的 SAM 應用程式無法執行，請前往 Output (輸出) 視窗查看錯誤是否因未建置 Docker 映像所致。您可能需要釋放環境中的磁碟空間。

   如需詳細資訊，請參閱在 AWS Toolkit 中於本機執行 SAM 應用程式時發生錯誤，因為 AWS Cloud9 環境沒有足夠的磁碟空間。

   當除錯工作階段啟動時，DEBUG CONSOLE (除錯主控台) 面板會顯示除錯輸出，並顯示 Lambda 函數傳回的任何值。除錯 SAM 應用程式時，Output (輸出) 面板會將 AWS Toolkit 選為輸出管道。

   注意

   如果 Windows 使用者在此程序中遇到 Docker 掛載問題，您可能需要重新整理自己的共用磁碟機的憑證 (在 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。如未顯示新增除錯組態選項，您必須啟用程式碼濾鏡。若要啟用程式碼濾鏡，請參閱 啟用 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 應用程式時，Output (輸出) 面板會將 AWS Toolkit 選為輸出管道。

   注意

   如果錯誤訊息提及 Docker，請參閱本注意事項。

如何執行並除錯本機 API Gateway 資源

1. 選擇以下其中一種方法來建立 AWS SAM API Gateway 資源的啟動組態：

   • 選項 1：前往您 AWS SAM 的處理常式來源程式碼 (尤其是.js、.cs 或 .py 檔案) 專案，將游標懸浮在 Lambda 處理常式上，然後選擇 Add Debug Configuration (新增除錯組態)。如果未顯示新增除錯組態選項，請啟用程式碼濾鏡。若要啟用程式碼濾鏡，請參閱 啟用 AWS Toolkit 程式碼鏡頭 。然後，在選單中選擇標示為 API Event (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. 在 Console (主控台) 的 AWS Toolkit 索引標籤上確認部署成功。

   如果發生錯誤，右下角會顯示彈出式訊息。

   如果發生這種情況，請查看 AWS Toolkit 索引標籤中的文字了解詳情。以下是錯誤詳細資訊的範例。

   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 儲存貯體不存在，因此發生錯誤。