sam deploy

シェルに 秒の値でSAM_CLI_POLL_DELAY環境変数を設定し、 が AWS SAM AWS CloudFormation スタック状態CLIをチェックする頻度を設定します。これは、 からスロットリングを表示する場合に役立ちます AWS CloudFormation。この env 変数は、 の実行中に行われるdescribe_stackAPIコールのポーリングに使用されますsam deploy。

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

$ SAM_CLI_POLL_DELAY=5 sam deploy

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

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

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

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

が AWS SAM CLI は、計算された変更セットをデプロイします。

デバッグログを有効にして、 AWS SAM CLI は と を生成してタイムスタンプを表示します。

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

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

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

このオプションを指定すると、 AWS SAM CLI プロンプトを使用してデプロイをガイドします。

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

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

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

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

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

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

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

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

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

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

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

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

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

キーと値のペアとしてエンコードされた AWS CloudFormation パラメータを含む文字列。() と同じ形式を使用します AWS Command Line Interface AWS CLI。の AWS SAM CLI 形式は明示的なキーと値のキーワードで、各オーバーライドはスペースで区切られます。ここでは、以下の 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

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

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

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

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

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

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

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

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

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

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

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

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

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