sam deploy

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

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

• sam deploy コマンドの使用に関するドキュメントについては、 AWS SAMCLI「」を参照してくださいを使用したデプロイの概要 AWS SAM。

sam deploy コマンドは、 AWS クラウド を使用してアプリケーションを にデプロイします AWS CloudFormation。

使用状況

$ <environment variables> sam deploy <options>

環境変数

SAM_CLI_POLL_DELAY

シェルに 秒の値を持つSAM_CLI_POLL_DELAY環境変数を設定して、SAM AWS CLI が CloudFormation スタックの状態をチェックする頻度を設定します。これはスロットリングを表示するときに便利です CloudFormation。この環境変数は、sam deploy の実行中に行われる describe_stack API コールのポーリングに使用されます。

この変数の例を次に示します。

$ SAM_CLI_POLL_DELAY=5 sam deploy

オプション

--capabilities LIST

が特定のスタック CloudFormation を作成できるように指定する必要がある機能のリスト。一部のスタックテンプレートには AWS アカウント、新しい AWS Identity and Access Management (IAM) ユーザーを作成するなど、 のアクセス許可に影響するリソースが含まれている場合があります。このようなスタックについては、このパラメータを指定することによって、それらの機能を明示的に承認する必要があります。有効な値は、CAPABILITY_IAM と CAPABILITY_NAMED_IAM のみです。IAM リソースがある場合、どちらの機能でも指定できます。カスタム名を持つ IAM リソースがある場合は、CAPABILITY_NAMED_IAM を指定する必要があります。このオプションを指定しない場合は、オペレーションが InsufficientCapabilities エラーを返します。

ネストされたアプリケーションを含むアプリケーションをデプロイする場合は、 を使用して、アプリケーションにネストされたアプリケーションが含まれているCAPABILITY_AUTO_EXPANDことを確認する必要があります。詳細については、「ネストされたアプリケーションのデプロイ」を参照してください。

--config-env TEXT

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

--config-file PATH

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

--confirm-changeset | --no-confirm-changeset

AWS SAM CLI が計算された変更セットをデプロイするかどうかの確認を求めます。

--debug

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

--disable-rollback | --no-disable-rollback

デプロイ中にエラーが発生した場合に CloudFormation スタックをロールバックするかどうかを指定します。デフォルトでは、デプロイ中にエラーが発生した場合、 CloudFormation スタックは最後の安定状態に戻ります。--disable-rollback を指定した状態でデプロイ中にエラーが発生した場合、エラーが発生する前に作成または更新されたリソースはロールバックされません。

--fail-on-empty-changeset | --no-fail-on-empty-changeset

スタックに対して行う変更がない場合に 0 以外の終了コードを返すかどうかを指定します。デフォルトの動作では、ゼロ以外の終了コードが返されます。

--force-upload

このオプションを指定して、アーティファクトが Amazon S3 バケット内の既存のアーティファクトと一致する場合でも、それらをアップロードします。一致するアーティファクトは上書きされます。

--guided, -g

このオプションを指定して、デプロイ全体で AWS SAM CLI によるプロンプトを用いたガイドを有効にします。

--help

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

--image-repositories TEXT

関数の Amazon ECR リポジトリ URI へのマッピングです。論理 ID で関数を参照します。以下に例を示します。

$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo

このオプションは 1 つのコマンドで複数回指定できます。

--image-repository TEXT

このコマンドが関数のイメージをアップロードする Amazon ECR リポジトリの名前です。このオプションは、Image パッケージタイプで宣言された関数に必要です。

--kms-key-id TEXT

Amazon S3 バケットに保管されているアーティファクトを暗号化するために使用される AWS Key Management Service (AWS KMS) キーの ID。 Amazon S3 このオプションを指定しない場合、 は Amazon S3-managed暗号化キー AWS SAM を使用します。

--metadata

テンプレートで参照されるすべてのアーティファクトにアタッチするメタデータのマップです。

--no-execute-changeset

変更セットを適用するかどうかを示します。このオプションは、変更セットを適用する前にスタックの変更を表示したい場合に指定します。このコマンドは、 CloudFormation 変更セットを作成してから、その変更セットを適用せずに終了します。変更セットを適用するには、このオプションを指定せずに同じコマンドを実行します。

--no-progressbar

Amazon S3 へのアーティファクトのアップロード時に、進行状況バーを表示しません。

--notification-arns LIST

スタック CloudFormation に関連付ける Amazon Simple Notification Service (Amazon SNS) トピック ARNs のリスト。

--on-failure [ROLLBACK | DELETE | DO_NOTHING]

スタックの作成が失敗されたときに実行するアクションを指定します。

以下のオプションが利用できます。

• ROLLBACK — スタックを以前の既知の正常な状態にロールバックします。

• DELETE — 以前の既知の正常な状態が存在する場合、スタックを以前の既知の状態にロールバックします。以前の既知の正常な状態が存在しない場合は、スタックを削除します。

• DO_NOTHING — スタックのロールバックおよび削除を行いません。この結果は --disable-rollback の結果と同じです。

デフォルトの動作は ROLLBACK です。

注記

--disable-rollback オプションまたは --on-failure オプションを指定できますが、両方を指定することはできません。

--parameter-overrides LIST

キーと値のペアとしてエンコードされた CloudFormation パラメータオーバーライドを含む文字列。各オーバーライドは 形式を使用しますParameterKey=name,ParameterValue=value。複数のオーバーライドはスペースで区切られます。ここでは、以下の 2 つの例を示します。

$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2

$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana

--profile TEXT

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

--region TEXT

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

--resolve-image-repos

ガイドなしデプロイのパッケージ化およびデプロイに使用する Amazon ECR リポジトリを自動的に作成します。このオプションは、PackageType: Image が指定された関数とレイヤーにのみ適用されます。--guided オプションを指定すると、 AWS SAM CLI は --resolve-image-repos を無視します。

注記

がこのオプションを使用して関数またはレイヤーの Amazon ECR リポジトリ AWS SAM を自動的に作成し、後で AWS SAM テンプレートからそれらの関数またはレイヤーを削除すると、対応する Amazon ECR リポジトリは自動的に削除されます。

--resolve-s3

ガイドなしデプロイのパッケージ化とデプロイに使用する Amazon S3 バケットを自動的に作成します。--guided オプションを指定すると、 AWS SAM CLI は --resolve-s3 を無視します。--s3-bucket と --resolve-s3 の両方のオプションを指定するとエラーが発生します。

--role-arn TEXT

変更セットを適用するときに が CloudFormation 引き受ける IAM ロールの Amazon リソースネーム (ARN)。

--s3-bucket TEXT

このコマンドが CloudFormation テンプレートをアップロードする Amazon S3 バケットの名前。テンプレートが 51,200 バイトより大きい場合は、--s3-bucket オプションまたは --resolve-s3 オプションは必須です。--s3-bucket と --resolve-s3 の両方のオプションを指定するとエラーが発生します。

--s3-prefix TEXT

Amazon S3 バケットにアップロードされるアーティファクト名に追加されたプレフィックスです。プレフィックス名は、Amazon S3 バケットのパス名 (フォルダ名) です。

--save-params

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

--signing-profiles LIST

デプロイパッケージに署名するための署名プロファイルのリストです。このオプションはキーバリューペアのリストを使用します。このペアのキーは署名する関数またはレイヤーの名前、値は署名プロファイルで、オプションのプロファイル所有者は : で区切られます。例えば、FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner。

--stack-name TEXT

(必須) デプロイ先の CloudFormation スタックの名前。既存のスタックを指定すると、コマンドはスタックを更新します。新しいスタックを指定すると、コマンドはスタックを作成します。

--tags LIST

作成または更新されたスタックに関連付けるタグのリスト。 は、これらのタグをサポートしているスタック内のリソース CloudFormation にも伝播します。

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

AWS SAM テンプレートがあるパスとファイル名。

注記

このオプションを指定すると、 はテンプレートとそれが指すローカルリソースのみを AWS SAM デプロイします。

--use-json

CloudFormation テンプレートの JSON を出力します。デフォルトの出力は YAML です。

例

sam deploy サブコマンドの使用での、詳細な例と詳しいチュートリアルについては、「を使用したデプロイの概要 AWS SAM」を参照してください。