AWS SAM CLI の使用

AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) と AWS SAM テンプレートおよびサポートされているサードパーティー統合を使用して、サーバーレスアプリケーションを構築および実行します。

AWS SAM の概要については、「とは何ですか AWS SAM?」を参照してください。

トピック

• AWS SAM CLI コマンドを文書化する方法
• AWS SAM CLI の設定
• sam build を使用する
• sam deploy を使用する
• sam init を使用する
• sam local を使用する
• sam remote invoke を使用する
• sam remote test-event を使用する
• sam sync を使用する

AWS SAM CLI コマンドを文書化する方法

AWS SAM CLI コマンドは、次の形式で文書化されています。

• プロンプト – Linux プロンプトはデフォルトで文書化され、($ ) として表示されます。Windows 固有のコマンドの場合、(> ) がプロンプトとして使用されます。コマンドを入力した場合はプロンプトを含めないでください。

• ディレクトリ – 特定のディレクトリからコマンドを実行する必要がある場合は、プロンプト記号の前にディレクトリ名が表示されます。

• ユーザー入力 – コマンドラインに入力するコマンドテキストは、user input としてフォーマットされます。

• 置換可能なテキスト – ファイル名やパラメータなどの可変テキストは、replaceable text としてフォーマットされます。複数行のコマンドまたは特定のキーボード入力が必要なコマンドの場合、キーボード入力も置き換え可能なテキストとして表示できます。例えば ENTER のようになります。

• 出力 – コマンドに対するレスポンスとして返される出力は、computer output としてフォーマットされます。

次の sam deploy コマンドと出力は例です。

$ sam deploy --guided --template template.yaml

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]: ENTER
    #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

1. sam deploy --guided --template template.yaml は、コマンドラインで入力するコマンドです。

2. sam deploy --guided --template はそのまま指定する必要があります。

3. template.yaml は、特定のファイル名に置き換えることができます。

4. 出力は Configuring SAM deploy から始まります。

5. 出力では、ENTER と y は、指定した置換可能な値を示します。