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

# sam pipeline bootstrap
<a name="sam-cli-command-reference-sam-pipeline-bootstrap"></a>

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

の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)

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

このサブコマンドは、次の AWS インフラストラクチャリソースを設定します。
+ パイプラインのアクセス許可を設定するオプション:
  + CI/CD システムと共有されるアクセスキー ID とシークレットキーのアクセス認証情報を持つパイプライン IAM ユーザー。
**注記**  
アクセスキーを定期的にローテーションすることをお勧めします。詳細については、IAM ユーザーガイドの「[長期的な認証情報を必要とするユースケースのためにアクセスキーを定期的にローテーションする](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#rotate-credentials)」を参照してください。
  + OIDC を通じてサポートされている CI/CD プラットフォーム。 AWS SAM パイプラインで OIDC を使用する方法の概要については、「[AWS SAM パイプラインで OIDC 認証を使用する方法](deploying-with-oidc.md)」を参照してください。
+  AWS SAM アプリケーションをデプロイ CloudFormation するために が引き受ける CloudFormation 実行 IAM ロール。
+  AWS SAM アーティファクトを保持する Amazon S3 バケット。
+ オプションで、コンテナイメージの Lambda デプロイパッケージを保持するための Amazon ECR イメージリポジトリ (パッケージタイプが `Image` のリソースがある場合)。

## 使用方法
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-usage"></a>

```
$ sam pipeline bootstrap <options>
```

## オプション
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-options"></a>

`--bitbucket-repo-uuid TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-bitbucket-repo-uuid"></a>
 Bitbucket リポジトリの UUID です。このオプションは、アクセス許可に Bitbucket OIDC を使用する場合に固有です。  
この値は https://bitbucket.org/*workspace*/*repository*/admin/addon/admin/pipelines/openid-connect にあります。

`--bucket TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-bucket"></a>
 AWS SAM アーティファクトを保持する Amazon S3 バケットの ARN。

`--cicd-provider TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-cicd-provider"></a>
 AWS SAM パイプラインの CI/CD プラットフォーム。

`--cloudformation-execution-role TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-cloudformation-execution-role"></a>
アプリケーションのスタックのデプロイ CloudFormation 中に が引き受ける IAM ロールの ARN。独自のロールを使用したい場合にのみ提供します。提供されない場合は、このコマンドによって新しいロールが作成されます。

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-config-env"></a>
使用する設定ファイル内のデフォルトのパラメータ値を指定する環境名です。デフォルト値は **default** です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある `samconfig.toml` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--confirm-changeset | --no-confirm-changeset`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-confirm-changeset"></a>
リソースのデプロイを確認するプロンプトが表示されます。

`--create-image-repository | --no-create-image-repository`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-create-image-repository"></a>
Amazon ECR イメージリポジトリが提供されていない場合に、それを作成するかどうかを指定します。Amazon ECR リポジトリは、パッケージタイプが `Image` の Lambda 関数またはレイヤーのコンテナイメージを保持します。デフォルトは `--no-create-image-repository` です。

`--debug`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力し、タイムスタンプを表示します。

`--deployment-branch TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-deployment-branch"></a>
デプロイ元のブランチの名前です。このオプションは、アクセス許可に GitHub Actions OIDC を使用する場合に固有です。

`--github-org TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-github-org"></a>
リポジトリが属する GitHub 組織です。組織が存在しない場合は、リポジトリ所有者のユーザー名を入力します。このオプションは、アクセス許可に GitHub Actions OIDC を使用する場合に固有です。

`--github-repo TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-github-repo"></a>
デプロイ元の GitHub リポジトリの名前です。このオプションは、アクセス許可に GitHub Actions OIDC を使用する場合に固有です。

`--gitlab-group TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-gitlab-group"></a>
リポジトリが属する GitLab グループです。このオプションは、アクセス許可に GitLab OIDC を使用する場合に固有です。

`--gitlab-project TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-gitlab-project"></a>
GitLab のプロジェクトの名前です。このオプションは、アクセス許可に GitLab OIDC を使用する場合に固有です。

`--help, -h`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-help"></a>
このメッセージを表示して終了します。

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-image-repository"></a>
パッケージタイプが `Image` の Lambda 関数またはレイヤーのコンテナイメージを保持する Amazon ECR イメージリポジトリの ARN です。提供されている場合は、`--create-image-repository` オプションが無視されます。提供されておらず、`--create-image-repository` が指定されている場合は、コマンドによって作成されます。

`--interactive | --no-interactive`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-interactive"></a>
bootstrap パラメータのインタラクティブなプロンプトを無効にし、必要なパラメータが欠落している場合は失敗します。デフォルト値は `--interactive` です。このコマンドの必須パラメータは `--stage` のみです。  
`--no-interactive` が `--use-oidc-provider` と一緒に指定される場合は、OIDC プロバイダーの必須パラメータをすべて含める必要があります。

`--oidc-client-id TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-client-id"></a>
OIDC プロバイダーで使用するように設定されたクライアント ID です。

`--oidc-provider [github-actions | gitlab | bitbucket-pipelines]`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-provider"></a>
OIDC アクセス許可に使用される CI/CD プロバイダーの名前です。GitLab、GitHub、および Bitbucket がサポートされています。

`--oidc-provider-url TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-provider-url"></a>
OIDC プロバイダーの URL です。値は **https://** で始める必要があります。

`--permissions-provider [oidc | iam]`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-permissions-provider"></a>
パイプラインの実行ロールを取得するアクセス許可プロバイダーを選択します。デフォルト値は **iam** です。

`--pipeline-execution-role TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-pipeline-execution-role"></a>
このステージでの動作のためにパイプラインユーザーが引き受ける IAM ロールの ARN です。独自のロールを使用したい場合にのみ提供します。提供されない場合は、このコマンドによって新しいロールが作成されます。

`--pipeline-user TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-pipeline-user"></a>
アクセスキー ID とシークレットアクセスキーが CI/CD システムと共有されている IAM ユーザーの Amazon リソースネーム (ARN) です。これは、対応する AWS アカウントにアクセスするためのアクセス許可をこの IAM ユーザーに付与するために使用されます。提供されていない場合、コマンドによってアクセスキー ID とシークレットアクセスキーの認証情報と共に IAM ユーザーロールが作成されます。

`--profile TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-region"></a>
デプロイ先の AWS リージョン。例えば、`us-east-1`。

`--save-params`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--stage TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-stage"></a>
対応するデプロイメントステージの名前です。これは、作成された AWS インフラストラクチャリソースのサフィックスとして使用されます。

## トラブルシューティング
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-troubleshooting"></a>

### エラー: 必須パラメータがありません
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-troubleshooting-example1"></a>

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

## 例
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-examples"></a>

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

```
$ sam pipeline bootstrap --debug
```