sam init

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

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

• sam init コマンドの使用に関するドキュメントについては、 AWS SAMCLI「」を参照してくださいでアプリケーションを作成する AWS SAM。

sam init コマンドには、新しいサーバーレス アプリケーションを初期化するためのオプションがあります。

使用方法

$ sam init <options>

オプション

--app-template TEXT

使用するマネージドアプリケーションテンプレートの識別子です。よくわからない場合は、インタラクティブなワークフローのオプションを指定せずに sam init を呼び出します。

このパラメータは、--no-interactive が指定され、--location が指定されていない場合に必要です。

このパラメータは、0.30.0 以降の AWS SAM CLI バージョンのみで利用できます。それより前のバージョンでこのパラメータを指定すると、エラーが発生します。

--application-insights | --no-application-insights

アプリケーションでの Amazon CloudWatch Application Insights のモニタリングを有効にします。詳細についてはCloudWatch Application Insights を使用して AWS SAM サーバーレスアプリケーションをモニタリングするを参照してください。

デフォルトのオプションは --no-application-insights です。

--architecture, -a [ x86_64 | arm64 ]

アプリケーションの Lambda 関数の命令セットアーキテクチャ。x86_64 または arm64 のいずれかを指定します。

--base-image [ amazon/dotnet8-base | amazon/dotnet6-base | amazon/java21-base | amazon/java17-base | amazon/java11-base | amazon/nodejs22.x-base | amazon/nodejs20.x-base | amazon/nodejs18.x-base | amazon/nodejs16.x-base | amazon/python3.13-base | amazon/python3.12-base | amazon/python3.11-base | amazon/python3.10-base | amazon/python3.9-base | amazon/python3.8-base | amazon/ruby3.4-base | amazon/ruby3.3-base | amazon/ruby3.2-base ]

アプリケーションのベースイメージです。このオプションは、パッケージタイプが Image の場合のみに適用されます。

このパラメータは、--no-interactive が指定されている、--package-type が Image として指定されている、および --location が指定されていない場合に必要です。

--config-env TEXT

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

--config-file PATH

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

--debug

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

--dependency-manager, -d [ gradle | mod | maven | bundler | npm | cli-package | pip ]

Lambda ランタイムの依存関係マネージャーです。

--extra-content

テンプレートの cookiecutter.json 設定にあるカスタムパラメータ ({"customParam1": "customValue1", "customParam2":"customValue2"} など) を上書きします。

--help, -h

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

--location, -l TEXT

テンプレートまたはアプリケーションの場所 (Git、Mercurial、HTTP/HTTPS、zip ファイル、パス) です。

このパラメータは、--no-interactive が指定されていて、--runtime、--name、および --app-template が提供されていない場合に必要です。

Git リポジトリの場合は、リポジトリのルートの場所を使用する必要があります。

ローカルパスの場合、テンプレートは.zip ファイルまたは Cookiecutter 形式にする必要があります。

--name, -n TEXT

ディレクトリとして生成されるプロジェクトの名前です。

このパラメータは、--no-interactive が指定され、--location が指定されていない場合に必要です。

--no-input

Cookiecutter プロンプトを無効にし、テンプレート設定で定義されている vcfdefault 値を受け入れます。

--no-interactive

init パラメータのインタラクティブなプロンプトを無効にし、必要な値が欠落している場合は失敗します。

--output-dir, -o PATH

初期化されたアプリケーションが出力される場所です。

--package-type [ Zip | Image ]

サンプルアプリケーションのパッケージタイプです。Zip は .zip ファイルアーカイブを作成し、Image はコンテナイメージを作成します。

--runtime, -r [ dotnet8 | dotnet6 | java21 | java17 | java11 | nodejs22.x | nodejs20.x | nodejs18.x | nodejs16.x | python3.13 | python3.12 | python3.11 | python3.10 | python3.9 | python3.8 | ruby3.4 | ruby3.3 | ruby3.2 ]

アプリケーションの Lambda ランタイムです。このオプションは、パッケージタイプが Zip の場合のみに適用されます。

このパラメータは、--no-interactive が指定されている、--package-type が Zip として指定されている、および --location が指定されていない場合に必要です。

--save-params

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

--tracing | --no-tracing

Lambda 関数の AWS X-Ray トレースを有効にします。

例

sam init サブコマンドの使用での、詳細な例と詳しいチュートリアルについては、「でアプリケーションを作成する AWS SAM」を参照してください。