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 アプリケーションをデプロイするために CloudFormation が引き受ける CloudFormation 実行 IAM ロール。

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

  • オプションで、コンテナイメージの Lambda デプロイパッケージを保持するための Amazon ECR イメージリポジトリ (パッケージタイプが 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

アプリケーションのスタックのデプロイ中に 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 リポジトリは、パッケージタイプが Image の Lambda 関数またはレイヤーのコンテナイメージを保持します。デフォルトは --no-create-image-repository です。

--debug

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

--deployment-branch TEXT

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

--github-org TEXT

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

--github-repo TEXT

デプロイ元の GitHub リポジトリの名前です。このオプションは、アクセス許可に GitHub Actions OIDC を使用する場合に固有です。

--gitlab-group TEXT

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

--gitlab-project TEXT

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

--help, -h

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

--image-repository TEXT

パッケージタイプが Image の Lambda 関数またはレイヤーのコンテナイメージを保持する Amazon ECR イメージリポジトリの ARN です。提供されている場合は、--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

アクセスキー ID とシークレットアクセスキーが CI/CD システムと共有されている IAM ユーザーの Amazon リソースネーム (ARN) です。これは、対応する AWS アカウントにアクセスする許可をこの IAM ユーザーに付与するために使用されます。提供されていない場合、コマンドによってアクセスキー 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 によって生成されたデバッグメッセージを出力します。 また、s3.json イベントを使用しローカルで Lambda 関数を呼び出すことで、生成されたイベントをローカルのテストに使用します。

$ sam pipeline bootstrap --debug