sam pipeline bootstrap - AWS Serverless Application Model
用量選項故障診斷範例

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

sam pipeline bootstrap

此頁面提供 AWS Serverless Application Model 命令列界面 (AWS SAMCLI) sam local pipeline bootstrap子命令的參考資訊。

如需 的簡介 AWS SAMCLI，請參閱 什麼是 AWS SAMCLI？

sam pipeline bootstrap 子命令會產生必要的 AWS 基礎設施資源，以連線至您的 CI/CD 系統。執行 sam pipeline init命令之前，必須先針對管道中的每個部署階段執行此步驟。

此子命令會設定下列 AWS 基礎設施資源：

  • 可透過下列方式設定管道許可的選項：

  • 由 擔任 AWS CloudFormation 以部署 AWS SAM 應用程式的 AWS CloudFormation 執行 IAM 角色。

  • 保存 AWS SAM 成品的 Amazon S3 儲存貯體。

  • 或者， Amazon ECR 映像儲存庫可保留容器映像 Lambda 部署套件 （如果您有套件類型 的資源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 SAMCLI 組態檔案。

--config-file PATH

組態檔案的路徑和檔案名稱，其中包含要使用的預設參數值。預設值位於專案目錄的根samconfig.toml目錄中。如需關於組態檔案的詳細資訊，請參閱 AWS SAMCLI 組態檔案。

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

提示 確認您的資源部署。

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

指定是否在未提供的情況下建立 Amazon ECR 映像儲存庫。Amazon ECR 儲存庫會保留 Lambda 函數的容器映像，或套件類型為 的層Image。預設值為 --no-create-image-repository。

--debug

開啟偵錯記錄，並列印 AWS SAMCLI產生的偵錯訊息，以及顯示時間戳記。

--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

Amazon ECR 映像儲存庫的 ARN，該儲存庫會存放 Lambda 函數的容器映像，或套件類型為 的層Image。如果提供，則會忽略--create-image-repository選項。如果未提供 且--create-image-repository已指定 ，則命令會建立一個。

--interactive | --no-interactive

停用引導參數的互動式提示，如果缺少任何必要的參數，則失敗。預設值為 --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

IAM 使用者的 Amazon Resource Name (ARN)，具有與 CI/CD 系統共用的存取金鑰 ID 和私密存取金鑰。它用於授予此 IAM 使用者存取對應 AWS 帳戶的許可。如果未提供，命令會建立 IAM 使用者，以及存取金鑰 ID 和私密存取金鑰憑證。

--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 SAMCLI： 使用產生的事件進行本機測試，方法是使用s3.json事件在本機叫用 Lambda 函數

$ sam pipeline bootstrap --debug