翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# sam deploy
<a name="sam-cli-command-reference-sam-deploy"></a>

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam deploy` コマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam deploy` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[を使用したデプロイの概要 AWS SAM](using-sam-cli-deploy.md)。

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

## Usage
<a name="ref-sam-cli-deploy-usage"></a>

```
$ <environment variables> sam deploy <options>
```

## 環境変数
<a name="ref-sam-cli-deploy-env"></a>

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

```
$ SAM_CLI_POLL_DELAY=5 sam deploy
```

## オプション
<a name="ref-sam-cli-deploy-options"></a>

`--capabilities LIST`  <a name="ref-sam-cli-deploy-options-capabilities"></a>
が特定のスタックを作成 CloudFormation できるように指定する必要がある機能のリスト。一部のスタックテンプレートには AWS アカウント、新しい AWS Identity and Access Management (IAM) ユーザーを作成するなど、 のアクセス許可に影響するリソースが含まれている場合があります。このようなスタックについては、このパラメータを指定することによって、それらの機能を明示的に承認する必要があります。有効な値は、`CAPABILITY_IAM` と `CAPABILITY_NAMED_IAM` のみです。IAM リソースがある場合、どちらの機能でも指定できます。カスタム名を持つ IAM リソースがある場合は、`CAPABILITY_NAMED_IAM` を指定する必要があります。このオプションを指定しない場合は、オペレーションが `InsufficientCapabilities` エラーを返します。  
ネストされたアプリケーションを含むアプリケーションをデプロイする場合は、アプリケーションにネストされたアプリケーションが含まれることを承認するために `CAPABILITY_AUTO_EXPAND` を使用する必要があります。詳細については、「[ネストされたアプリケーションのデプロイ](serverless-sam-template-nested-applications.md#serverless-sam-templates-nested-applications-deploying)」を参照してください。

`--config-env TEXT`  <a name="ref-sam-cli-deploy-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は `default` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="ref-sam-cli-deploy-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある `samconfig.toml` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--confirm-changeset | --no-confirm-changeset`  <a name="ref-sam-cli-deploy-options-confirm-changeset"></a>
 AWS SAM CLI が計算された変更セットをデプロイするかどうかの確認を求めます。

`--debug`  <a name="ref-sam-cli-deploy-options-debug"></a>
デバッグロギングを有効にして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

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

`--fail-on-empty-changeset | --no-fail-on-empty-changeset`  <a name="ref-sam-cli-deploy-options-fail-on-empty-changeset"></a>
スタックに対して行う変更がない場合に 0 以外の終了コードを返すかどうかを指定します。デフォルトの動作では、ゼロ以外の終了コードが返されます。

`--force-upload`  <a name="ref-sam-cli-deploy-options-force-upload"></a>
このオプションを指定して、アーティファクトが Amazon S3 バケット内の既存のアーティファクトと一致する場合でも、それらをアップロードします。一致するアーティファクトは上書きされます。

`--guided, -g`  <a name="ref-sam-cli-deploy-options-guided"></a>
このオプションを指定して、デプロイ全体で AWS SAM CLI によるプロンプトを用いたガイドを有効にします。

`--help`  <a name="ref-sam-cli-deploy-options-help"></a>
このメッセージを表示して終了します。

`--image-repositories TEXT`  <a name="ref-sam-cli-deploy-options-image-repositories"></a>
関数の Amazon ECR リポジトリ URI へのマッピングです。論理 ID で関数を参照します。以下に例を示します。  

```
$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo
```
このオプションは 1 つのコマンドで複数回指定できます。

`--image-repository TEXT`  <a name="ref-sam-cli-deploy-options-image-repository"></a>
このコマンドが関数のイメージをアップロードする Amazon ECR リポジトリの名前です。このオプションは、`Image` パッケージタイプで宣言された関数に必要です。

`--kms-key-id TEXT`  <a name="ref-sam-cli-deploy-options-kms-key-id"></a>
Amazon S3 バケットに保管されているアーティファクトを暗号化するために使用される AWS Key Management Service (AWS KMS) キーの ID。このオプションを指定しない場合、 は Amazon S3-managed暗号化キー AWS SAM を使用します。

`--metadata`  <a name="ref-sam-cli-deploy-options-metadata"></a>
テンプレートで参照されるすべてのアーティファクトにアタッチするメタデータのマップです。

`--no-execute-changeset`  <a name="ref-sam-cli-deploy-options-no-execute-changeset"></a>
変更セットを適用するかどうかを示します。このオプションは、変更セットを適用する前にスタックの変更を表示したい場合に指定します。このコマンドは、 CloudFormation 変更セットを作成してから、その変更セットを適用せずに終了します。変更セットを適用するには、このオプションを指定せずに同じコマンドを実行します。

`--no-progressbar`  <a name="ref-sam-cli-deploy-options-no-progressbar"></a>
Amazon S3 へのアーティファクトのアップロード時に、進行状況バーを表示しません。

`--notification-arns LIST`  <a name="ref-sam-cli-deploy-options-notification-arns"></a>
スタック CloudFormation に関連付ける Amazon Simple Notification Service (Amazon SNS) トピック ARNs のリスト。

`--on-failure [ROLLBACK | DELETE | DO_NOTHING]`  <a name="ref-sam-cli-deploy-options-on-failure"></a>
スタックの作成が失敗されたときに実行するアクションを指定します。  
以下のオプションが利用できます。  
+ `ROLLBACK` — スタックを以前の既知の正常な状態にロールバックします。
+ `DELETE` — 以前の既知の正常な状態が存在する場合、スタックを以前の既知の状態にロールバックします。以前の既知の正常な状態が存在しない場合は、スタックを削除します。
+ `DO_NOTHING` — スタックのロールバックおよび削除を行いません。この結果は `--disable-rollback` の結果と同じです。
デフォルトの動作は `ROLLBACK` です。  
`--disable-rollback` オプションまたは `--on-failure` オプションを指定できますが、両方を指定することはできません。

`--parameter-overrides LIST`  <a name="ref-sam-cli-deploy-options-parameter-overrides"></a>
キーと値のペアとしてエンコードされた 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`  <a name="ref-sam-cli-deploy-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="ref-sam-cli-deploy-options-region"></a>
 AWS リージョン デプロイ先の 。例えば、us-east-1 などです。

`--resolve-image-repos`  <a name="ref-sam-cli-deploy-options-resolve-image-repos"></a>
ガイドなしデプロイのパッケージ化およびデプロイに使用する Amazon ECR リポジトリを自動的に作成します。このオプションは、`PackageType: Image` が指定された関数とレイヤーにのみ適用されます。`--guided` オプションを指定すると、 AWS SAM CLI は `--resolve-image-repos` を無視します。  
がこのオプションを使用して関数またはレイヤーの Amazon ECR リポジトリ AWS SAM を自動的に作成し、後で AWS SAM テンプレートからそれらの関数またはレイヤーを削除すると、対応する Amazon ECR リポジトリは自動的に削除されます。

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

`--role-arn TEXT`  <a name="ref-sam-cli-deploy-options-role-arn"></a>
変更セットを適用するときに が CloudFormation 引き受ける IAM ロールの Amazon リソースネーム (ARN)。

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

`--s3-prefix TEXT`  <a name="ref-sam-cli-deploy-options-s3-prefix"></a>
Amazon S3 バケットにアップロードされるアーティファクト名に追加されたプレフィックスです。プレフィックス名は、Amazon S3 バケットのパス名 (フォルダ名) です。

`--save-params`  <a name="ref-sam-cli-deploy-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

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

`--stack-name TEXT`  <a name="ref-sam-cli-deploy-options-stack-name"></a>
(必須) デプロイ先の CloudFormation スタックの名前。既存のスタックを指定すると、コマンドはスタックを更新します。新しいスタックを指定すると、コマンドはスタックを作成します。

`--tags LIST`  <a name="ref-sam-cli-deploy-options-tags"></a>
作成または更新されたスタックに関連付けるタグのリスト。 は、これらのタグをサポートしているスタック内のリソース CloudFormation にも伝播します。

`--template-file, --template, -t PATH`  <a name="ref-sam-cli-deploy-options-template-file"></a>
 AWS SAM テンプレートがあるパスとファイル名。  
このオプションを指定すると、 はテンプレートとそれが指すローカルリソースのみを AWS SAM デプロイします。

`--use-json`  <a name="ref-sam-cli-deploy-options-use-json"></a>
 CloudFormation テンプレートの JSON を出力します。デフォルトの出力は YAML です。

## 例
<a name="sam-cli-command-reference-sam-deploy-examples"></a>

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