sam pipeline bootstrap - AWS Serverless Application Model
使用方法オプショントラブルシューティング例

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

sam pipeline bootstrap

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) sam local pipeline bootstrapサブコマンド。

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

sam pipeline bootstrap サブコマンドは、CI/CD システムに接続するために必要な AWS インフラストラクチャリソースを生成します。このステップは、sam pipeline init コマンドを実行する前に、パイプラインのデプロイステージごとに実行する必要があります。

このサブコマンドは、次の AWS インフラストラクチャリソースを設定します。

  • パイプラインのアクセス許可を設定するオプション:

  • AWS SAM アプリケーションをデプロイ AWS CloudFormation するために が引き受ける AWS CloudFormation 実行IAMロール。

  • AWS SAM アーティファクトを保持する Amazon S3 バケット。

  • オプションで、コンテナECRイメージ Lambda デプロイパッケージを保持する Amazon イメージリポジトリ (パッケージタイプ のリソースがある場合Image）。

使用方法

$ sam pipeline bootstrap <options>

オプション

--bitbucket-repo-uuid TEXT

Bitbucket リポジトリUUIDの 。このオプションは、アクセス許可に Bitbucket を使用することOIDCに固有のものです。

注記

この値は、https://bitbucket.org/ で確認できます。workspace/repository/admin/addon/admin/pipelines/openid-connect

--bucket TEXT

AWS SAM アーティファクトを保持する Amazon S3 バケットARNの 。

--cicd-provider TEXT

AWS SAM パイプラインの CI/CD プラットフォーム。

--cloudformation-execution-role TEXT

アプリケーションのスタックをデプロイ AWS CloudFormation するときに引き受けるIAMロールARNの 。独自のロールを使用したい場合にのみ提供します。提供されない場合は、このコマンドによって新しいロールが作成されます。

--config-env TEXT

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

--config-file PATH

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

--confirm-changeset | --no-confirm-changeset

リソースのデプロイを確認するプロンプトが表示されます。

--create-image-repository | --no-create-image-repository

何も指定されていない場合は、Amazon ECRイメージリポジトリを作成するかどうかを指定します。Amazon ECRリポジトリには、Lambda 関数のコンテナイメージ、または のパッケージタイプを持つレイヤーが保持されますImage。デフォルト: --no-create-image-repository。

--debug

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

--deployment-branch TEXT

デプロイ元のブランチの名前です。このオプションは、アクセス許可に GitHub アクションを使用することOIDCに固有のものです。

--github-org TEXT

リポジトリが属する GitHub 組織。組織が存在しない場合は、リポジトリ所有者のユーザー名を入力します。このオプションは、アクセス許可に アクションを使用すること GitHubOIDCに固有のものです。

--github-repo TEXT

デプロイが行われる GitHub リポジトリの名前。このオプションは、アクセス許可に GitHub アクションを使用することOIDCに固有のものです。

--gitlab-group TEXT

リポジトリが属する GitLab グループ。このオプションは、 アクセス許可に を使用すること GitLab OIDCに固有です。

--gitlab-project TEXT

GitLab プロジェクト名。このオプションは、 アクセス許可に を使用すること GitLab OIDCに固有です。

--help, -h

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

--image-repository TEXT

Lambda 関数ARNのコンテナイメージを保持する Amazon ECRイメージリポジトリ、または のパッケージタイプを持つレイヤーの Image。提供されている場合は、--create-image-repository オプションが無視されます。提供されておらず、--create-image-repository が指定されている場合は、コマンドによって作成されます。

--interactive | --no-interactive

bootstrap パラメータのインタラクティブなプロンプトを無効にし、必要なパラメータが欠落している場合は失敗します。デフォルト値は --interactive です。このコマンドの必須パラメータは --stage のみです。

注記

--no-interactive が とともに指定されている場合は--use-oidc-provider、OIDCプロバイダーに必要なすべてのパラメータを含める必要があります。

--oidc-client-id TEXT

OIDC プロバイダーで使用するように設定されたクライアント ID。

--oidc-provider [github-actions | gitlab | bitbucket-pipelines]

アクセスOIDC許可に使用される CI/CD プロバイダーの名前。 GitLab、 GitHub、および Bitbucket がサポートされています。

--oidc-provider-url TEXT

OIDC プロバイダーURLの 。値は https:// で始める必要があります。

--permissions-provider [oidc | iam]

パイプラインの実行ロールを取得するアクセス許可プロバイダーを選択します。デフォルト値は iam です。

--pipeline-execution-role TEXT

このステージで運用するためにパイプラインユーザーが引き受けるIAMロールARNの 。独自のロールを使用したい場合にのみ提供します。提供されない場合は、このコマンドによって新しいロールが作成されます。

--pipeline-user TEXT

CI/CD システムと共有されているアクセスキー ID とシークレットアクセスキーを持つIAMユーザーの Amazon リソースネーム (ARN）。これは、このIAMユーザーに、対応する AWS アカウントにアクセスするアクセス許可を付与するために使用されます。指定しない場合、 コマンドはアクセスキー ID とシークレットアクセスキー認証情報とともにIAMユーザーを作成します。

--profile TEXT

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

--region TEXT

デプロイ先の AWS リージョン。例えば、us-east-1 と指定します。

--save-params

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

--stage TEXT

対応するデプロイメントステージの名前です。これは、作成された AWS インフラストラクチャリソースのサフィックスとして使用されます。

トラブルシューティング

エラー: 必須パラメータがありません

--no-interactive が --use-oidc-provider と一緒に指定され、必須パラメータのいずれかが指定されていない場合、欠落しているパラメータの説明とともにこのエラーメッセージが表示されます。

例

次の例では、CI/CD システムの作成に必要な AWS リソースを作成し、デバッグログ記録を有効にし、 によって生成されたデバッグメッセージを出力します。 AWS SAM CLI: イベントを使用して Lambda 関数をローカルで呼び出すことで、生成されたs3.jsonイベントをローカルテストに使用します。

$ sam pipeline bootstrap --debug