sam validate

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAMCLI) sam validate コマンドのリファレンス情報を提供します。

の概要については AWS SAMCLI、「」を参照してください。 AWS SAMCLIとは

sam validate コマンドは、 AWS SAM テンプレートファイルが有効かどうかを確認します。

使用方法

$ sam validate <options>

オプション

--config-env TEXT

使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--config-file PATH

使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--debug

デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

--lint

cfn-lint を通じてテンプレートのリンティング検証を実行します。cfnlintrc 設定ファイルを作成して、追加のパラメータを指定します。詳細については、AWS CloudFormation GitHub リポジトリの cfn-lint を参照してください。

--profile TEXT

認証情報を取得する AWS 認証情報ファイルの特定のプロファイル。

--region TEXT

デプロイ先の AWS リージョン。例えば、us-east-1 などです。

--save-params

コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

--template-file, --template, -t PATH

AWS SAM テンプレートファイル。デフォルト値は template.[yaml|yml] です。

テンプレートが現在の作業ディレクトリにあり、template.[yaml|yml|json] という名前が付けられている場合、このオプションは必須ではありません。

sam build を実行したばかりの場合は、このオプションは不要です。

例

テンプレート検証のための、このコマンドの使用例については「AWS SAM テンプレートファイルを検証する」を参照してください。

cfn-lint でこのコマンドを使用する例については、「Linter AWS CloudFormation で AWS SAM アプリケーションを検証する」を参照してください。