チュートリアル: Hello World アプリケーションのデプロイ - AWS Serverless Application Model

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

チュートリアル: Hello World アプリケーションのデプロイ

このチュートリアルでは、AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) を使用して次を実行します。

  • サンプルの Hello World アプリケーションを初期化、構築、デプロイします。

  • ローカルで変更を加えて AWS CloudFormation に同期します。

  • AWS クラウド でアプリケーションをテストします。

  • 必要に応じて、開発ホストでローカルテストを実行します。

  • AWS クラウド からサンプルアプリケーションを削除します。

サンプルの Hello World アプリケーションは、基本的な API バックエンドを実装しています。これは次のリソースで構成されます。

  • Amazon API Gateway – 関数を呼び出すために使用する API エンドポイント。

  • AWS Lambda – HTTP API GET リクエストを処理し、hello world メッセージを返す関数。

  • AWS Identity and Access Management (IAM) ロール – サービスが安全にインタラクションするための許可をプロビジョニングします。

以下の図は、このアプリケーションのコンポーネントを示しています。


			API Gateway エンドポイントに GET リクエストを送信するときに呼び出される Lambda 関数の図。

前提条件

次を完了していることを確認します。

ステップ 1: サンプルの Hello World アプリケーションを初期化する

このステップでは、AWS SAM CLI を使用して、ローカルマシン上にサンプルの Hello World アプリケーションプロジェクトを作成します。

サンプルの Hello World アプリケーションを初期化するには
  1. コマンドラインで、選択した開始ディレクトリから次を実行します。

    $ sam init
  2. AWS SAM CLI は、新しいアプリケーションの初期化を通じてユーザーをガイドします。次を設定します。

    1. [AWS クイックスタートテンプレート] を選択して、開始テンプレートを選択します。

    2. [Hello World Example] テンプレートを選択してダウンロードします。

    3. Python ランタイムと zip パッケージタイプを使用します。

    4. このチュートリアルでは、AWS X-Ray トレースをオプトアウトします。詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray とは」を参照してください。

    5. このチュートリアルでは、Amazon CloudWatch Application Insights によるモニタリングをオプトアウトします。詳細については、「Amazon ユーザーガイド」の「Amazon CloudWatch Application Insights」を参照してください。 CloudWatch

    6. アプリケーションに sam-app という名前を付けます。

    AWS SAM CLI インタラクティブフローを使用するには:

    • 括弧 ([ ]) はデフォルト値を示します。回答を空白のままにすると、デフォルト値が選択されます。

    • はいの場合は y と入力し、いいえの場合は n と入力します。

    sam init インタラクティブフローの例を次に示します。

    $ sam init ... Which template source would you like to use? 1 - AWS Quick Start Templates 2 - Custom Template Location Choice: 1 Choose an AWS Quick Start application template 1 - Hello World Example 2 - Multi-step workflow 3 - Serverless API 4 - Scheduled task 5 - Standalone function 6 - Data processing 7 - Hello World Example With Powertools 8 - Infrastructure event management 9 - Serverless Connector Hello World Example 10 - Multi-step workflow with Connectors 11 - Lambda EFS example 12 - DynamoDB Example 13 - Machine Learning Template: 1 Use the most popular runtime and package type? (Python and zip) [y/N]: y Would you like to enable X-Ray tracing on the function(s) in your application? [y/N]: ENTER Would you like to enable monitoring using CloudWatch Application Insights? For more info, please view https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-application-insights.html [y/N]: ENTER Project name [sam-app]: ENTER
  3. AWS SAM CLI は開始テンプレートをダウンロードし、ローカルマシン上にアプリケーションプロジェクトのディレクトリ構造を作成します。次は AWS SAM CLI の出力例です。

    Cloning from https://github.com/aws/aws-sam-cli-app-templates (process may take a moment)
    
        -----------------------
        Generating application:
        -----------------------
        Name: sam-app
        Runtime: python3.9
        Architectures: x86_64
        Dependency Manager: pip
        Application Template: hello-world
        Output Directory: .
        Configuration file: sam-app/samconfig.toml
    
        Next steps can be found in the README file at sam-app/README.md
    
    
    Commands you can use next
    =========================
    [*] Create pipeline: cd sam-app && sam pipeline init --bootstrap
    [*] Validate SAM template: cd sam-app && sam validate
    [*] Test Function in the Cloud: cd sam-app && sam sync --stack-name {stack-name} --watch
  4. コマンドラインから、新しく作成した sam-app ディレクトリに移動します。AWS SAM CLI が作成したものの例を次に示します。

    $ cd sam-app $ tree ├── README.md ├── __init__.py ├── events │ └── event.json ├── hello_world │ ├── __init__.py │ ├── app.py │ └── requirements.txt ├── samconfig.toml ├── template.yaml └── tests ├── __init__.py ├── integration │ ├── __init__.py │ └── test_api_gateway.py ├── requirements.txt └── unit ├── __init__.py └── test_handler.py 6 directories, 14 files

    強調すべきいくつかの重要なファイル:

    • hello_world/app.py – Lambda 関数コードが含まれます。

    • hello_world/requirements.txt – Lambda 関数に必要な Python 依存関係が含まれます。

    • samconfig.toml – AWS SAM CLI によって使用されるデフォルトのパラメータを保存するアプリケーションの設定ファイル。

    • template.yaml – アプリケーションインフラストラクチャコードを含む AWS SAM テンプレート。

これで、サーバーレスアプリケーションがローカルマシン上に完成しました。

ステップ 2: アプリケーションを構築する

このステップでは、 AWS SAM CLI を使用してアプリケーションを構築し、デプロイの準備をします。構築すると、AWS SAM CLI は .aws-sam ディレクトリを作成し、そこに関数の依存関係、プロジェクトコード、およびプロジェクトファイルを整理します。

アプリケーションを構築するには
  • コマンドラインで、sam-app プロジェクトディレクトリから次を実行します。

    $ sam build
    注記

    ローカルマシンに Python がない場合は、代わりに sam build --use-container コマンドを使用します。AWS SAM CLI は、関数のランタイムと依存関係を含む Docker コンテナを作成します。このコマンドを使用するには、ローカルマシン上に Docker が必要です。Docker をインストールするには、「Docker のインストール」を参照してください。

    次は AWS SAM CLI の出力例です。

    $ sam build Starting Build use cache Manifest file is changed (new hash: 3298f1304...d4d421) or dependency folder (.aws-sam/deps/4d3dfad6-a267-47a6-a6cd-e07d6fae318c) is missing for (HelloWorldFunction), downloading dependencies and copying/building source Building codeuri: /Users/.../Demo/sam-tutorial1/sam-app/hello_world runtime: python3.9 metadata: {} architecture: x86_64 functions: HelloWorldFunction Running PythonPipBuilder:CleanUp Running PythonPipBuilder:ResolveDependencies Running PythonPipBuilder:CopySource Running PythonPipBuilder:CopySource Build Succeeded Built Artifacts : .aws-sam/build Built Template : .aws-sam/build/template.yaml Commands you can use next ========================= [*] Validate SAM template: sam validate [*] Invoke Function: sam local invoke [*] Test Function in the Cloud: sam sync --stack-name {{stack-name}} --watch [*] Deploy: sam deploy --guided

    AWS SAM CLI によって作成される .aws-sam ディレクトリの短い例を次に示します。

    .aws-sam
    ├── build
    │   ├── HelloWorldFunction
    │   │   ├── __init__.py
    │   │   ├── app.py
    │   │   └── requirements.txt
    │   └── template.yaml
    └── build.toml

強調すべきいくつかの重要なファイル:

  • build/HelloWorldFunction – Lambda 関数のコードと依存関係が含まれます。AWS SAM CLI は、アプリケーション内の関数ごとにディレクトリを作成します。

  • build/template.yaml – デプロイ時に AWS CloudFormation によって参照される AWS SAM テンプレートのコピーが含まれます。

  • build.toml – アプリケーションの構築およびデプロイ時に AWS SAM CLI によって参照されるデフォルトのパラメータ値を保存する設定ファイル。

これで、アプリケーションを AWS クラウド にデプロイする準備が整いました。

ステップ 3: アプリケーションを AWS クラウド にデプロイする

注記

このステップでは、AWS 認証情報の設定が必要です。詳細については、「AWS SAM の前提条件」の ステップ 5: AWS CLI を使用して AWS 認証情報を設定する を参照してください。

このステップでは、AWS SAM CLI を使用してアプリケーションを AWS クラウド にデプロイします。AWS SAM CLI は次を実行します。

  • デプロイのためのアプリケーション設定を通じてユーザーをガイドします。

  • アプリケーションファイルを Amazon Simple Storage Service (Amazon S3) にアップロードします。

  • AWS SAM テンプレートを AWS CloudFormation テンプレートに変換します。その後、テンプレートを AWS CloudFormation サービスにアップロードして、AWS リソースをプロビジョニングします。

アプリケーションをデプロイするには
  1. コマンドラインで、sam-app プロジェクトディレクトリから次を実行します。

    $ sam deploy --guided
  2. AWS SAM CLI のインタラクティブフローに従って、アプリケーション設定を構成します。次を設定します。

    1. AWS CloudFormation スタック名 – スタックは、単一の単位として管理できる AWS リソースのコレクションです。詳細については、「AWS CloudFormation ユーザーガイド」の「スタックの操作」を参照してください。

    2. AWS CloudFormation スタックをデプロイする AWS リージョン。詳細については、「AWS CloudFormation ユーザーガイド」の「AWS CloudFormation エンドポイント」を参照してください。

    3. このチュートリアルでは、デプロイ前の変更の確認をオプトアウトします。

    4. IAM ロールの作成を許可 – これにより、AWS SAM は、API Gateway リソースと Lambda 関数リソースがインタラクションするために必要な IAM ロールを作成できます。

    5. このチュートリアルでは、ロールバックの無効化をオプトアウトします。

    6. HelloWorldFunction 認証が定義されていない状態で許可する – このメッセージは、API Gateway エンドポイントが認証なしでパブリックにアクセス可能になるように設定されているために表示されます。これは Hello World アプリケーション用に意図された設定であるため、 AWS SAM CLI の続行を許可します。認可の設定の詳細については、「API Gateway API へのアクセスの制御」を参照してください。

    7. 引数を設定ファイルに保存 – これにより、アプリケーションの samconfig.toml ファイルがデプロイ設定で更新されます。

    8. デフォルトの設定ファイル名を選択します。

    9. デフォルトの設定環境を選択します。

    sam deploy --guided インタラクティブフローの出力例を次に示します。

    $ sam-app sam deploy --guided Configuring SAM deploy ====================== Looking for config file [samconfig.toml] : Found Reading default arguments : Success Setting default arguments for 'sam deploy' ========================================= Stack Name [sam-app]: ENTER AWS Region [us-west-2]: ENTER #Shows you resources changes to be deployed and require a 'Y' to initiate deploy Confirm changes before deploy [Y/n]: n #SAM needs permission to be able to create roles to connect to the resources in your template Allow SAM CLI IAM role creation [Y/n]: ENTER #Preserves the state of previously provisioned resources when an operation fails Disable rollback [y/N]: ENTER HelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y Save arguments to configuration file [Y/n]: ENTER SAM configuration file [samconfig.toml]: ENTER SAM configuration environment [default]: ENTER
  3. AWS SAM CLI は次を実行することによってアプリケーションをデプロイします。

    • AWS SAM CLI は Amazon S3 バケットを作成し、.aws-sam ディレクトリをアップロードします。

    • AWS SAM CLI は AWS SAM テンプレートを AWS CloudFormation に変換し、AWS CloudFormation サービスにアップロードします。

    • AWS CloudFormation はリソースをプロビジョニングします。

    デプロイ中、AWS SAM CLI は進行状況を表示します。以下は、その出力例です。

    Looking for resources needed for deployment:
    
        Managed S3 bucket: aws-sam-cli-managed-default-samclisourcebucket-1a4x26zbcdkqr
        A different default S3 bucket can be set in samconfig.toml
    
        Parameter "stack_name=sam-app" in [default.deploy.parameters] is defined as a global parameter [default.global.parameters].
        This parameter will be only saved under [default.global.parameters] in /Users/.../Demo/sam-tutorial1/sam-app/samconfig.toml.
    
        Saved arguments to config file
        Running 'sam deploy' for future deployments will use the parameters saved above.
        The above parameters can be changed by modifying samconfig.toml
        Learn more about samconfig.toml syntax at
        https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-config.html
    
    File with same data already exists at sam-app/da3c598813f1c2151579b73ad788cac8, skipping upload
    
        Deploying with following values
        ===============================
        Stack name                   : sam-app
        Region                       : us-west-2
        Confirm changeset            : False
        Disable rollback             : False
        Deployment s3 bucket         : aws-sam-cli-managed-default-samclisourcebucket-1a4x26zbcdkqr
        Capabilities                 : ["CAPABILITY_IAM"]
        Parameter overrides          : {}
        Signing Profiles             : {}
    
    Initiating deployment
    =====================
    
    File with same data already exists at sam-app/2bebf67c79f6a743cc5312f6dfc1efee.template, skipping upload
    
    
    Waiting for changeset to be created..
    
    CloudFormation stack changeset
    ---------------------------------------------------------------------------------------------------------------------------------------------
    Operation                           LogicalResourceId                   ResourceType                        Replacement
    ---------------------------------------------------------------------------------------------------------------------------------------------
    * Modify                            HelloWorldFunction                  AWS::Lambda::Function               False
    * Modify                            ServerlessRestApi                   AWS::ApiGateway::RestApi            False
    - Delete                            AwsSamAutoDependencyLayerNestedSt   AWS::CloudFormation::Stack          N/A
                                        ack
    ---------------------------------------------------------------------------------------------------------------------------------------------
    
    
    Changeset created successfully. arn:aws:cloudformation:us-west-2:012345678910:changeSet/samcli-deploy1678917603/22e05525-08f9-4c52-a2c4-f7f1fd055072
    
    
    2023-03-15 12:00:16 - Waiting for stack create/update to complete
    
    CloudFormation events from stack operations (refresh every 0.5 seconds)
    ---------------------------------------------------------------------------------------------------------------------------------------------
    ResourceStatus                      ResourceType                        LogicalResourceId                   ResourceStatusReason
    ---------------------------------------------------------------------------------------------------------------------------------------------
    UPDATE_IN_PROGRESS                  AWS::Lambda::Function               HelloWorldFunction                  -
    UPDATE_COMPLETE                     AWS::Lambda::Function               HelloWorldFunction                  -
    UPDATE_COMPLETE_CLEANUP_IN_PROGRE   AWS::CloudFormation::Stack          sam-app                             -
    SS
    DELETE_IN_PROGRESS                  AWS::CloudFormation::Stack          AwsSamAutoDependencyLayerNestedSt   -
                                                                            ack
    DELETE_COMPLETE                     AWS::CloudFormation::Stack          AwsSamAutoDependencyLayerNestedSt   -
                                                                            ack
    UPDATE_COMPLETE                     AWS::CloudFormation::Stack          sam-app                             -
    ---------------------------------------------------------------------------------------------------------------------------------------------
    
    CloudFormation outputs from deployed stack
    ----------------------------------------------------------------------------------------------------------------------------------------------
    Outputs
    ----------------------------------------------------------------------------------------------------------------------------------------------
    Key                 HelloWorldFunctionIamRole
    Description         Implicit IAM Role created for Hello World function
    Value               arn:aws:iam::012345678910:role/sam-app-HelloWorldFunctionRole-15GLOUR9LMT1W
    
    Key                 HelloWorldApi
    Description         API Gateway endpoint URL for Prod stage for Hello World function
    Value               https://<restapiid>.execute-api.us-west-2.amazonaws.com/Prod/hello/
    
    Key                 HelloWorldFunction
    Description         Hello World Lambda Function ARN
    Value               arn:aws:lambda:us-west-2:012345678910:function:sam-app-HelloWorldFunction-yQDNe17r9maD
    ----------------------------------------------------------------------------------------------------------------------------------------------
    
    
    Successfully created/updated stack - sam-app in us-west-2

これで、アプリケーションがデプロイされ、AWS クラウド で実行するようになりました。

ステップ 4: アプリケーションを実行する

このステップでは、API エンドポイントに GET リクエストを送信し、Lambda 関数の出力を確認します。

API エンドポイントの値を取得するには
  1. 前のステップで AWS SAM CLI によって表示された情報から、Outputs セクションを見つけます。このセクションで、HelloWorldApi リソースを見つけて HTTP エンドポイントの値を確認します。出力例を次に示します。

    ----------------------------------------------------------------------------------------------------------------------------------------------
    Outputs
    ----------------------------------------------------------------------------------------------------------------------------------------------
    ...
    Key                 HelloWorldApi
    Description         API Gateway endpoint URL for Prod stage for Hello World function
    Value               https://ets1gv8lxi.execute-api.us-west-2.amazonaws.com/Prod/hello/
    ...
    ----------------------------------------------------------------------------------------------------------------------------------------------
  2. あるいは、sam list endpoints --output json コマンドを使用してこの情報を取得することもできます。出力例を次に示します。

    $ sam list endpoints --output json 2023-03-15 12:39:19 Loading policies from IAM... 2023-03-15 12:39:25 Finished loading policies from IAM. [ { "LogicalResourceId": "HelloWorldFunction", "PhysicalResourceId": "sam-app-HelloWorldFunction-yQDNe17r9maD", "CloudEndpoint": "-", "Methods": "-" }, { "LogicalResourceId": "ServerlessRestApi", "PhysicalResourceId": "ets1gv8lxi", "CloudEndpoint": [ "https://ets1gv8lxi.execute-api.us-west-2.amazonaws.com/Prod", "https://ets1gv8lxi.execute-api.us-west-2.amazonaws.com/Stage" ], "Methods": [ "/hello['get']" ] } ]
関数を呼び出すには
  • ブラウザまたはコマンドラインを使用して、API エンドポイントに GET リクエストを送信します。curl コマンドを使用した例を次に示します。

    $ curl https://ets1gv8lxi.execute-api.us-west-2.amazonaws.com/Prod/hello/ {"message": "hello world"}

ステップ 5: AWS クラウド内の関数とやり取りする

このステップでは、AWS SAM CLI を使用して AWS クラウド 内の Lambda 関数を呼び出します。

クラウド内の Lambda 関数を呼び出す
  1. 前のステップから、関数の LogicalResourceId を書き留めておきます。これは、HelloWorldFunction になります。

  2. コマンドラインで、sam-app プロジェクトディレクトリから次を実行します。

    $ sam remote invoke HelloWorldFunction --stack-name sam-app
  3. AWS SAM CLI はクラウド内の関数を呼び出し、レスポンスを返します。以下は、その出力例です。

    $ sam remote invoke HelloWorldFunction --stack-name sam-app Invoking Lambda Function HelloWorldFunction START RequestId: d5ef494b-5f45-4086-86fd-d7322fa1a1f9 Version: $LATEST END RequestId: d5ef494b-5f45-4086-86fd-d7322fa1a1f9 REPORT RequestId: d5ef494b-5f45-4086-86fd-d7322fa1a1f9 Duration: 6.62 ms Billed Duration: 7 ms Memory Size: 128 MB Max Memory Used: 67 MB Init Duration: 164.06 ms {"statusCode":200,"body":"{\"message\":\"hello world\"}"}%

ステップ 6: アプリケーションを変更して AWS クラウド に同期する

このステップでは、AWS SAM CLI の sam sync --watch コマンドを使用して、ローカルの変更を AWS クラウド に同期します。

sam sync を使用するには
  1. コマンドラインで、sam-app プロジェクトディレクトリから次を実行します。

    $ sam sync --watch
  2. AWS SAM CLI は、開発スタックを同期しようとしていることを確認するよう促すプロンプトを表示します。sam sync --watch コマンドはローカルの変更をリアルタイムで自動的に AWS クラウド にデプロイするため、開発環境のみに使用することをお勧めします。

    AWS SAM CLI は、ローカルの変更のモニタリングを開始する前に、初期デプロイを実行します。以下は、その出力例です。

    $ sam sync --watch The SAM CLI will use the AWS Lambda, Amazon API Gateway, and AWS StepFunctions APIs to upload your code without performing a CloudFormation deployment. This will cause drift in your CloudFormation stack. **The sync command should only be used against a development stack**. Confirm that you are synchronizing a development stack. Enter Y to proceed with the command, or enter N to cancel: [Y/n]: y Queued infra sync. Waiting for in progress code syncs to complete... Starting infra sync. Manifest is not changed for (HelloWorldFunction), running incremental build Building codeuri: /Users/.../Demo/sam-tutorial1/sam-app/hello_world runtime: python3.9 metadata: {} architecture: x86_64 functions: HelloWorldFunction Running PythonPipBuilder:CopySource Build Succeeded Successfully packaged artifacts and wrote output template to file /var/folders/45/5ct135bx3fn2551_ptl5g6_80000gr/T/tmpq3x9vh63. Execute the following command to deploy the packaged template sam deploy --template-file /var/folders/45/5ct135bx3fn2551_ptl5g6_80000gr/T/tmpq3x9vh63 --stack-name <YOUR STACK NAME> Deploying with following values =============================== Stack name : sam-app Region : us-west-2 Disable rollback : False Deployment s3 bucket : aws-sam-cli-managed-default-samclisourcebucket-1a4x26zbcdkqr Capabilities : ["CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"] Parameter overrides : {} Signing Profiles : null Initiating deployment ===================== 2023-03-15 13:10:05 - Waiting for stack create/update to complete CloudFormation events from stack operations (refresh every 0.5 seconds) --------------------------------------------------------------------------------------------------------------------------------------------- ResourceStatus ResourceType LogicalResourceId ResourceStatusReason --------------------------------------------------------------------------------------------------------------------------------------------- UPDATE_IN_PROGRESS AWS::CloudFormation::Stack sam-app Transformation succeeded CREATE_IN_PROGRESS AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt - ack CREATE_IN_PROGRESS AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt Resource creation Initiated ack CREATE_COMPLETE AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt - ack UPDATE_IN_PROGRESS AWS::Lambda::Function HelloWorldFunction - UPDATE_COMPLETE AWS::Lambda::Function HelloWorldFunction - UPDATE_COMPLETE_CLEANUP_IN_PROGRE AWS::CloudFormation::Stack sam-app - SS UPDATE_COMPLETE AWS::CloudFormation::Stack sam-app - --------------------------------------------------------------------------------------------------------------------------------------------- CloudFormation outputs from deployed stack ---------------------------------------------------------------------------------------------------------------------------------------------- Outputs ---------------------------------------------------------------------------------------------------------------------------------------------- Key HelloWorldFunctionIamRole Description Implicit IAM Role created for Hello World function Value arn:aws:iam::012345678910:role/sam-app-HelloWorldFunctionRole-15GLOUR9LMT1W Key HelloWorldApi Description API Gateway endpoint URL for Prod stage for Hello World function Value https://ets1gv8lxi.execute-api.us-west-2.amazonaws.com/Prod/hello/ Key HelloWorldFunction Description Hello World Lambda Function ARN Value arn:aws:lambda:us-west-2:012345678910:function:sam-app-HelloWorldFunction-yQDNe17r9maD ---------------------------------------------------------------------------------------------------------------------------------------------- Stack update succeeded. Sync infra completed. Infra sync completed. CodeTrigger not created as CodeUri or DefinitionUri is missing for ServerlessRestApi.

次に、Lambda 関数のコードを変更します。AWS SAM CLI はこの変更を自動的に検出し、アプリケーションを AWS クラウド に同期します。

アプリケーションを変更して同期するには
  1. 選択した IDE で sam-app/hello_world/app.py ファイルを開きます。

  2. message を変更してファイルを保存します。以下に例を示します。

    import json ... def lambda_handler(event, context): ... return { "statusCode": 200, "body": json.dumps({ "message": "hello everyone!", ... }), }
  3. AWS SAM CLI は変更を検出し、アプリケーションを AWS クラウド に同期します。以下は、その出力例です。

    Syncing Lambda Function HelloWorldFunction...
    Manifest is not changed for (HelloWorldFunction), running incremental build
    Building codeuri: /Users/.../Demo/sam-tutorial1/sam-app/hello_world runtime: python3.9 metadata: {} architecture: x86_64 functions: HelloWorldFunction
    Running PythonPipBuilder:CopySource
    Finished syncing Lambda Function HelloWorldFunction.
  4. 変更を確認するには、API エンドポイントに GET リクエストを再度送信します。

    $ curl https://ets1gv8lxi.execute-api.us-west-2.amazonaws.com/Prod/hello/ {"message": "hello everyone!"}

ステップ 7: (オプション) アプリケーションをローカルでテストする

注記

このステップは、ローカルマシン上に Docker を必要とするため、オプションです。

重要

ローカルテストに AWS SAM CLI を使用するには、Docker をインストールして設定しておく必要があります。詳細については、「Docker のインストール」を参照してください。

このステップでは、AWS SAM CLI の sam local コマンドを使用してアプリケーションをローカルでテストします。これを実現するために、AWS SAM CLI は Docker を使用してローカル環境を作成します。このローカル環境は、Lambda 関数のクラウドベースの実行環境をエミュレートします。

以下の作業を実行します。

  1. Lambda 関数のローカル環境を作成し、呼び出します。

  2. HTTP API エンドポイントをローカルでホストし、それを使用して Lambda 関数を呼び出します。

Lambda 関数をローカルで呼び出すには
  1. コマンドラインで、sam-app プロジェクトディレクトリから次を実行します。

    $ sam local invoke
  2. AWS SAM CLI はローカル Docker コンテナを作成し、関数を呼び出します。以下は、その出力例です。

    $ sam local invoke Invoking app.lambda_handler (python3.9) Local image was not found. Removing rapid images for repo public.ecr.aws/sam/emulation-python3.9 Building image..................... Using local image: public.ecr.aws/lambda/python:3.9-rapid-x86_64. Mounting /Users/.../Demo/sam-tutorial1/sam-app/.aws-sam/build/HelloWorldFunction as /var/task:ro,delegated inside runtime container START RequestId: b046db01-2a00-415d-af97-35f3a02e9eb6 Version: $LATEST END RequestId: b046db01-2a00-415d-af97-35f3a02e9eb6 REPORT RequestId: b046db01-2a00-415d-af97-35f3a02e9eb6 Init Duration: 1.01 ms Duration: 633.45 ms Billed Duration: 634 ms Memory Size: 128 MB Max Memory Used: 128 MB {"statusCode": 200, "body": "{\"message\": \"hello world\"}"}
API をローカルでホストするには
  1. コマンドラインで、sam-app プロジェクトディレクトリから次を実行します。

    $ sam local start-api
  2. AWS SAM CLI は、Lambda 関数用にローカル Docker コンテナを作成し、API エンドポイントをシミュレートするローカル HTTP サーバーを作成します。以下は、その出力例です。

    $ sam local start-api Initializing the lambda functions containers. Local image is up-to-date Using local image: public.ecr.aws/lambda/python:3.9-rapid-x86_64. Mounting /Users/.../Demo/sam-tutorial1/sam-app/.aws-sam/build/HelloWorldFunction as /var/task:ro,delegated inside runtime container Containers Initialization is done. Mounting HelloWorldFunction at http://127.0.0.1:3000/hello [GET] You can now browse to the above endpoints to invoke your functions. You do not need to restart/reload SAM CLI while working on your functions, changes will be reflected instantly/automatically. If you used sam build before running local commands, you will need to re-run sam build for the changes to be picked up. You only need to restart SAM CLI if you update your AWS SAM template 2023-03-15 14:25:21 WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on http://127.0.0.1:3000 2023-03-15 14:25:21 Press CTRL+C to quit
  3. ブラウザまたはコマンドラインを使用して、ローカル API エンドポイントに GET リクエストを送信します。curl コマンドを使用した例を次に示します。

    $ curl http://127.0.0.1:3000/hello {"message": "hello world"}

ステップ 8: AWS クラウドからアプリケーションを削除する

このステップでは、AWS SAM CLI の sam delete コマンドを使用して、アプリケーションを AWS クラウド から削除します。

AWS クラウド からアプリケーションを削除するには
  1. コマンドラインで、sam-app プロジェクトディレクトリから次を実行します。

    $ sam delete
  2. AWS SAM CLI から確認するよう求められます。その後、アプリケーションの Amazon S3 バケットと AWS CloudFormation スタックが削除されます。出力例を次に示します。

    $ sam delete Are you sure you want to delete the stack sam-app in the region us-west-2 ? [y/N]: y Are you sure you want to delete the folder sam-app in S3 which contains the artifacts? [y/N]: y - Deleting S3 object with key c6ce8fa8b5a97dd022ecd006536eb5a4 - Deleting S3 object with key 5d513a459d062d644f3b7dd0c8b56a2a.template - Deleting S3 object with key sam-app/2bebf67c79f6a743cc5312f6dfc1efee.template - Deleting S3 object with key sam-app/6b208d0e42ad15d1cee77d967834784b.template - Deleting S3 object with key sam-app/da3c598813f1c2151579b73ad788cac8 - Deleting S3 object with key sam-app/f798cdd93cee188a71d120f14a035b11 - Deleting Cloudformation stack sam-app Deleted successfully

トラブルシューティング

AWS SAM CLI をトラブルシューティングするには、「AWS SAMCLI トラブルシューティング」を参照してください。

詳細はこちら

AWS SAM の詳細については、次のリソースを参照してください。