sam build

オプション。AWS SAM テンプレートで宣言された単一のリソースを構築するよう AWS SAM に指示します。指定されたリソースのビルドアーティファクトは、ワークフローの後続コマンド (つまり、sam package と sam deploy) に使用できる唯一のアーティファクトになります。

関数またはレイヤーのソースコードへの相対パスを、このディレクトリを基準にして解決します。このオプションは、ソースコードフォルダへの相対パスの解決方法を変更したい場合に使用します。デフォルトで、相対パスは AWS SAM テンプレートの場所を基準にして解決されます。

このオプションは、構築しているルートアプリケーションまたはスタックのリソースに加えて、ネストされたアプリケーションまたはスタックにも適用されます。

このオプションは、以下のリソースタイプとプロパティに適用されます。

ベータ機能を許可または拒否します。

ビルドアーティファクトが保存されているディレクトリへのパスです。このオプションを使用すると、このディレクトリとそのコンテンツのすべてが削除されます。

ビルド用にプルするコンテナイメージの URI です。デフォルトで、AWS SAM は Amazon ECR Public からコンテナイメージをプルします。このオプションは、別の場所からイメージをプルするために使用します。

このオプションは複数回指定できます。このオプションの各インスタンスには、文字列またはキーバリューペアを使用できます。文字列を指定する場合は、アプリケーション内のすべてのリソースに使用するコンテナイメージの URI になります。例えば、sam build --use-container --build-image amazon/aws-sam-cli-build-image-python3.8。キーバリューペアを指定する場合、キーはリソース名で、値はそのリソースに使用するコンテナイメージの URI です。例えば、sam build --use-container --build-image Function1=amazon/aws-sam-cli-build-image-python3.8 です。キーバリューペアを使用すると、異なるリソースに異なるコンテナイメージを指定できます。

このオプションは、--use-container オプションが指定されている場合のみに適用され、指定されていない場合はエラーが発生します。

ソースフォルダにプロジェクトを直接構築するには --build-in-source を指定します。

--build-in-source オプションは、次のランタイムとビルドメソッドをサポートします:

--build-in-source オプションは、次のオプションとは互換性がありません:

[Default] (デフォルト): --no-build-in-source

キャッシュされたビルドを有効または無効にします。このオプションは、以前のビルドから変更されていないビルドアーティファクトを再利用するために使用します。AWS SAM は、プロジェクトディレクトリ内のファイルが変更されたかどうかを評価します。デフォルトでは、ビルドはキャッシュされません。--no-cached オプションが呼び出されると、samconfig.toml の cached = true 設定が上書きされます。

--cached が指定されている場合にキャッシュアーティファクトが保存されるディレクトリです。デフォルトのキャッシュディレクトリは .aws-sam/cache です。

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

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

ビルドコンテナに渡す環境変数です。このオプションは複数回指定できます。このオプションの各インスタンスは、キーバリューペアを使用します。このペアのキーはリソースと環境変数で、値は環境変数の値です。例: --container-env-var Function1.GITHUB_TOKEN=TOKEN1 --container-env-var Function2.GITHUB_TOKEN=TOKEN2。

このオプションは、--use-container オプションが指定されている場合のみに適用され、指定されていない場合はエラーが発生します。

コンテナの環境変数の値が含まれる JSON ファイルのパスとファイル名です。コンテナ環境変数ファイルの詳細については、「コンテナ環境変数ファイル」を参照してください。

このオプションは、--use-container オプションが指定されている場合のみに適用され、指定されていない場合はエラーが発生します。

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

デフォルトのブリッジネットワークと共に、Lambda Docker コンテナが接続する必要がある既存の Docker ネットワークの名前または ID を指定します。指定されていない場合、Lambda コンテナはデフォルトのブリッジ Docker ネットワークのみに接続します。

sam build から除外するリソースの名前。例えば、テンプレートに Function1、Function2、Function3 が含まれていて、sam build --exclude Function2 を実行する場合、Function1 および Function3 だけが構築されます。

このメッセージを表示して終了します。

AWS SAM CLI 機能の拡張に使用されるフックの名前。

許容値: terraform。

デフォルトの代わりに使用する、カスタム依存関係のマニフェストファイル (package.json など) へのパスです。

AWS SAM CLI が常にファイル内のシンボリックリンクをマウントして構築または呼び出しを行うようにします。これは、最上位ディレクトリのシンボリックリンク (つまり、関数のルートに直接作成されたシンボリックリンク) にのみ適用されます。デフォルトで、NodeJS で node_modules に build-in-source を使用するために必要なシンボリックリンク以外はマウントされません。

デフォルトの動作の設定に IDE ツールキットを使用できるようにするオプションです。sam build --no-use-container を使用して、Docker コンテナの代わりにローカルマシンでビルドを実行することもできます。

並列ビルドを有効にします。このオプションを使用して、AWS SAM テンプレートの関数とレイヤーを並列的に作成します。デフォルトで、関数とレイヤーは順番に構築されます。

(オプション) キーバリューペアとしてエンコードされた、CloudFormation パラメータオーバーライドが含まれる文字列です。AWS Command Line Interface (AWS CLI) と同じ形式を使用します。例えば、「ParameterKey=KeyPairName, ParameterValue=MyKey ParameterKey=InstanceType, ParameterValue=t1.micro」などです。このオプションは --hook-name と互換性がありません。

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

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

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

インフラストラクチャに変更が加えられていない場合は、準備段階をスキップします。--hook-name オプションと合わせて使用します。

コマンドが Lambda ランタイム用の最新 Docker イメージのプルダウンをスキップするべきかどうかを指定します。

AWS SAM テンプレートファイル [default: template.[yaml|yml]] のパスと名前です。このオプションは --hook-name と互換性がありません。

Terraform設定ファイルまたは関数ソースコードを含む最上位ディレクトリへの相対パスまたは絶対パス。Terraformこれらのファイルがルートモジュールを含むディレクトリの外部にある場合は、このオプションを使用して絶対パスまたは相対パスを指定します。このオプションは --hook-name を terraform に設定する必要があります。

関数がネイティブにコンパイルされた依存関係を持つパッケージに依存する場合は、このオプションを使用して、Lambda に似た Docker コンテナ内で関数を構築します。