sam publish

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

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

sam publish コマンドは、AWS SAM アプリケーションを AWS Serverless Application Repository に公開します。このコマンドは、パッケージ化された AWS SAM テンプレートを受け取り、指定された AWS リージョンにアプリケーションを公開します。

sam publish コマンドは、公開に必要なアプリケーションメタデータを包含する Metadata セクションが AWS SAM テンプレートに含まれていることを期待します。Metadata セクションでは、LicenseUrl および ReadmeUrl プロパティがローカルファイルではなく、Amazon Simple Storage Service (Amazon S3) バケットを参照する必要があります。AWS SAM テンプレートの Metadata セクションに関する詳細については、「AWS SAM CLI を使用してアプリケーションを公開する」を参照してください。

デフォルトで、sam publish はアプリケーションをプライベートとして作成します。他の AWS アカウントによるアプリケーションの表示とデプロイを許可する前に、アプリケーションを共有する必要があります。アプリケーションの共有については、AWS Serverless Application Repository デベロッパーガイドの「AWS Serverless Application Repository Resource-Based Policy Examples」を参照してください。

注記

sam publish は現在、ローカルに指定されているネストされたアプリケーションの公開をサポートしていません。アプリケーションにネストされたアプリケーションが含まれている場合は、親アプリケーションを公開する前に、それらを個別に AWS Serverless Application Repository に公開する必要があります。

使用方法

$ sam publish <options>

オプション

--config-env TEXT

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

--config-file PATH

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

--debug

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

--help

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

--profile TEXT

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

--region TEXT

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

--save-params

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

--semantic-version TEXT

(オプション) このオプションを使用して、テンプレートファイルの Metadata セクションにある SemanticVersion プロパティを上書きするアプリケーションのセマンティックバージョンを提供します。セマンティックバージョニングの詳細については、「Semantic Versioning specification を参照してください。

--template, -t PATH

AWS SAM テンプレートファイル [default: template.[yaml|yml]] のパスです。

例

アプリケーションを発行するには

$ sam publish --template packaged.yaml --region us-east-1