sam deploy - AWS サーバーレスアプリケーションモデル

sam deploy

AWS SAM アプリケーションをデプロイします。

このコマンドには、ガイド付きインタラクティブモードが追加されました。このモードは、--guided パラメータを指定することで有効にできます。インタラクティブモードでは、デプロイに必要なパラメータが順番に示され、デフォルトのオプションが提供され、これらのオプションがプロジェクトフォルダの設定ファイルに保存されます。sam deploy を実行するだけで、アプリケーションの後続のデプロイを実行でき、必要なパラメータが AWS SAM CLI 設定ファイルから取得されます。

AWS CloudFormation を使用して Lambda 関数をデプロイするには、Lambda デプロイパッケージ用の Amazon S3 バケットが必要です。AWS SAM CLI は、この Amazon S3 バケットを作成して管理します。

使用:

sam deploy [OPTIONS] [ARGS]...

オプション:

オプション 説明
-g, --guided

このフラグを指定して、AWS SAM でガイド付きプロンプトを使用してデプロイをガイドできるようにします。

このパラメータの指定時に、必要に応じて保存される設定の詳細については、「AWS SAM CLI 設定」を参照してください。

--template-file PATH AWS SAM テンプレートが配置されているパス。デフォルト: template.[yaml|yml]。
--stack-name TEXT デプロイ先の AWS CloudFormation スタックの名前。既存のスタックを指定すると、コマンドはスタックを更新します。新しいスタックを指定すると、コマンドはスタックを作成します。必須。
--s3-bucket TEXT テンプレートで参照されるアーティファクトがある Amazon S3 バケットの名前。これは、51,200 バイトを超えるサイズのテンプレートをデプロイする場合に必要です。
--s3-prefix TEXT Amazon S3 バケットにアップロードされるアーティファクト名に追加されたプレフィックス。プレフィックス名は、Amazon S3 バケットのパス名 (フォルダ名) です。
--capabilities LIST AWS CloudFormation が特定のスタックを作成できるように指定する必要がある機能の一覧。一部のスタックテンプレートには、新しい AWS Identity and Access Management (IAM) ユーザーを作成する場合などで、AWS アカウントのアクセス権限に影響を与える可能性のあるリソースが含まれている場合があります。このようなスタックの場合は、このパラメータを指定して、それらの機能を明示的に認識する必要があります。有効な値は、CAPABILITY_IAMCAPABILITY_NAMED_IAM のみです。IAM リソースがある場合、どちらの機能でも指定できます。カスタム名を持つ IAM リソースがある場合は、CAPABILITY_NAMED_IAM を指定する必要があります。このパラメータを指定しない場合、このアクションは InsufficientCapabilities エラーを返します。
--region TEXT デプロイ先の AWS リージョン (us-east-1 など)。
--profile TEXT 認証情報ファイルから特定のプロファイルを選択して、AWS 認証情報を取得します。
--kms-key-id TEXT Amazon S3 バケットに保存されているアーティファクトを暗号化するために使用される AWS KMS キーの ID。
--force-upload Amazon S3 バケット内の既存のファイルを上書きします。Amazon S3 バケット内の既存のアーティファクトと一致する場合でも、アーティファクトをアップロードするには、このフラグを指定します。
--no-execute-changeset 変更セットを実行するかどうかを示します。変更セットを実行する前にスタックの変更を表示する場合は、このフラグを指定します。このコマンドは、AWS CloudFormation 変更セットを作成し、変更セットを実行せずに終了します。変更セットを実行する場合は、このフラグを指定せずに同じコマンドを実行することで、スタックの変更を行うことができます。
--role-arn TEXT 変更セットの実行時に AWS CloudFormation が引き受ける AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。
--fail-on-empty-changeset | --no-fail-on-empty-changeset スタックに変更を加えていない場合に 0 以外の終了コードを返すかどうかを指定します。デフォルトの動作では、ゼロ以外の終了コードが返されます。
--confirm-changeset 計算された変更セットをデプロイする前に確認を求めます。
--use-json AWS CloudFormation テンプレートの JSON を出力します。デフォルトで YAML が使用されます。
--metadata テンプレートで参照されているすべてのアーティファクトに添付するメタデータのマップ。省略可能。
--notification-arns LIST AWS CloudFormation がスタックに関連付ける Amazon Simple Notification Service トピック Amazon リソースネーム (ARN)。
--tags 作成または更新されたスタックに関連付けるタグの一覧。AWS CloudFormation では、リソースがスタックをサポートしている場合、これらのタグをスタックのリソースにも伝達します。
--parameter-overrides key=value のペアとしてエンコードされた AWS CloudFormation パラメータオーバーライドを含む文字列。AWS CLI と同じ形式を使用します。たとえば、ParameterKey=KeyPairName, ParameterValue=MyKey ParameterKey=InstanceTy pe,ParameterValue=t1.micro と指定します。
--デバッグ デバッグログを有効にします。
--help このメッセージを表示して終了します。