sam list resources - AWS Serverless Application Model
使用オプション例

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

sam list resources

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

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

sam list resources サブコマンドは、デプロイ時に AWS SAM 変換によって AWS CloudFormation で作成された AWS Serverless Application Model (AWS SAM) テンプレート内のリソースを表示します。

デプロイ前に AWS SAM テンプレートとともに sam list resources を使用して、作成されるリソースを確認します。デプロイされたリソースを含む統合リストを表示するには、CloudFormation スタック名を指定します。

注記

AWS SAM テンプレートからリソースのリストを生成するために、テンプレートのローカル変換が実行されます。このリストには、特定のリージョン内など、条件付きでデプロイされるリソースが含まれます。

使用

$ sam list resources <options>

オプション

--config-env TEXT

使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。

デフォルト値: default

設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--config-file TEXT

使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。

デフォルト値: 現在の作業ディレクトリ内の samconfig.toml。

設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--debug

デバッグログ記録をオンにして、AWS SAM CLI によって生成されたデバッグメッセージをタイムスタンプ付きで出力します。

--help, -h

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

--output [json|table]

結果を出力する形式を指定します。

デフォルト値: table

--profile TEXT

認証情報ファイルから特定のプロファイルを選択して、AWS 認証情報を取得します。

--region TEXT

サービスの AWS リージョンを設定します。例えば、us-east-1。

--save-params

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

--stack-name TEXT

デプロイされた CloudFormation スタックの名前。スタック名は、アプリケーションの samconfig.toml ファイルまたは指定された設定ファイルで見つけることができます。

指定されると、テンプレートのリソース論理 ID が CloudFormation の対応する物理 ID にマッピングされます。物理 ID の詳細については、「AWS CloudFormation ユーザーガイド」の「リソースフィールド」を参照してください。

このオプションが指定されていない場合、テンプレートで定義されているローカルリソースが表示されます。

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

AWS SAM テンプレートファイル。

デフォルト値: template.[yaml|yml|json]

例

AWS SAM テンプレートからのローカルリソースと、test-stack という名前の CloudFormation スタックからデプロイされたリソースの出力を表形式で表示します。ローカルテンプレートと同じディレクトリから実行します。

$ sam list resources --stack-name test-stack --output table
			
-------------------------------------------------------------------------------------------------------------------------
Logical ID                                                   Physical ID
-------------------------------------------------------------------------------------------------------------------------
HelloWorldFunction                                           sam-app-test-list-HelloWorldFunction-H85Y7yIV7ZLq
HelloWorldFunctionHelloWorldPermissionProd                   sam-app-test-list-
                                                             HelloWorldFunctionHelloWorldPermissionProd-1QH7CPOCBL2IK
HelloWorldFunctionRole                                       sam-app-test-list-HelloWorldFunctionRole-SRJDMJ6F7F41
ServerlessRestApi                                            uj80uoe2o2
ServerlessRestApiDeployment47fc2d5f9d                        pncw5f
ServerlessRestApiProdStage                                   Prod
ServerlessRestApiDeploymentf5716dc08b                        -
-------------------------------------------------------------------------------------------------------------------------