sam init - AWS Serverless Application Model

sam init

AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) の sam init コマンドのオプション。

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

  • AWS SAM CLI の sam init コマンドの使用に関するドキュメントについては、「sam init を使用する」を参照してください。

使用方法

$ sam init <options>

オプション

オプション 説明
-a, --architecture [x86_64 | arm64]

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

--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 を使用したサーバーレスアプリケーションのモニタリング」を参照してください。

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

--base-image [amazon/nodejs18.x-base | amazon/nodejs16.x-base | amazon/nodejs14.x-base | amazon/nodejs12.x-base | amazon/python3.10-base | amazon/python3.9-base | amazon/python3.8-base | amazon/python3.7-base | amazon/ruby3.2-base | amazon/ruby2.7-base | amazon/go1.x-base | amazon/java17-base | amazon/java11-base | amazon/java8.al2-base | amazon/java8-base | amazon/dotnet6-base | amazon/dotnet5.0-base | amazon/dotnetcore3.1-base ]

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

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

--config-file PATH 使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「AWS SAM CLI の設定ファイル」を参照してください。
--config-env TEXT 使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「AWS SAM CLI の設定ファイル」を参照してください。
-d, --dependency-manager [gradle | mod | maven | bundler | npm | cli-package | pip] Lambda ランタイムの依存関係マネージャーです。
--debug デバッグロギングをオンにして、AWS SAM CLI が生成するメッセージを出力表示し、タイムスタンプを表示します。
--extra-content テンプレートの cookiecutter.json 設定にあるカスタムパラメータ ({"customParam1": "customValue1", "customParam2":"customValue2"} など) を上書きします。
-h, --help このメッセージを表示して終了します。
-l, --location TEXT

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

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

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

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

-n, --name TEXT

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

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

--no-input Cookiecutter プロンプトを無効にし、テンプレート設定で定義されている vcfdefault 値を受け入れます。
--no-interactive init パラメータのインタラクティブなプロンプトを無効にし、必要な値が欠落している場合は失敗します。
-o, --output-dir PATH 初期化されたアプリケーションが出力される場所です。
--package-type [Zip | Image] サンプルアプリケーションのパッケージタイプです。Zip は .zip ファイルアーカイブを作成し、Image はコンテナイメージを作成します。
-r, --runtime [ruby2.7 | ruby3.2 | java8 | java8.al2 | java17 | java11 | nodejs12.x | nodejs14.x | nodejs16.x | nodejs18.x | dotnet6 | dotnet5.0 | dotnetcore3.1 | python3.10 | python3.9 | python3.8 | python3.7 | go1.x]

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

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

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