sam pipeline bootstrap - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

sam pipeline bootstrap

此命令生成连接到 CI/CD 系统所需的Amazon基础架构资源。在运行sam pipeline init命令之前,必须针对管道中的每个部署阶段运行此步骤。

此命令可设置以下Amazon基础架构资源:

  • 可选择通过以下方式配置管道权限:

  • 由担任的Amazon CloudFormation用于部署Amazon SAM应用程序的Amazon CloudFormation执行 IAM 角色。

  • 用于存放Amazon SAM工件的 Amazon S3 存储桶。

  • (可选)用于存放容器映像 Lambda 部署包的 Amazon ECR 镜像存储库(如果您的资源属于包Image类型)。

用法:

sam pipeline bootstrap [OPTIONS]

选项:

选项 描述
--config-env TEXT 在配置文件中指定要使用的默认参数值的环境名称。默认值为 default。有关配置文件的详细信息,请参阅 Amazon SAMCLI配置文件
--config-file PATH 包含要使用的默认参数值的配置文件的路径和文件名。默认值samconfig.toml位于项目目录的根目录中。有关配置文件的详细信息,请参阅 Amazon SAMCLI配置文件
--interactive | --no-interactive

禁用引导参数的交互式提示,如果缺少任何必需的参数,则失败。默认值为 --interactive。对于此命令,--stage是唯一必需的参数。

注意:如果同时指定--use-oidc-provider--no-interactive则必须包含您的 OIDC 提供商的所有必需参数。

--stage TEXT 相应部署阶段的名称。它用作创建Amazon的基础架构资源的后缀。
--pipeline-user TEXT 与 CI/CD 系统共享访问密钥 ID 和私有访问密钥的 IAM 用户的亚马逊资源名称 (ARN)。它用于向此 IAM 用户授予访问相应Amazon账户的权限。如果未提供,则该命令将创建一个 IAM 用户以及访问密钥 ID 和私有访问密钥证书。
--pipeline-execution-role TEXT 管道用户要担任的用于在此阶段操作的 IAM 角色的 ARN。仅在您想使用自己的角色时提供。如果未提供,则此命令将创建一个新角色。
--cloudformation-execution-role TEXT 部署应用程序堆栈Amazon CloudFormation时要担任的 IAM 角色的 ARN。仅在您想使用自己的角色时提供。否则,该命令将创建一个新角色。
--bucket TEXT 存放工件的 Amazon S3 存储桶的 ARN。Amazon SAM
--create-image-repository | --no-create-image-repository 如果未提供 Amazon ECR 镜像存储库,请指定是否要创建。Amazon ECR 存储库保存 Lambda 函数或包类型为的层的容器镜像。Image默认为 --no-create-image-repository
--image-repository TEXT 存放 Lambda 函数或包类型为的图层的容器镜像的 Amazon ECR 镜像存储库的 ARN。Image如果提供,则忽略这些--create-image-repository选项。如果未提供且--create-image-repository已指定,则该命令将创建一个。
--confirm-changeset | --no-confirm-changeset 提示您确认资源的部署。
--permissions-provider [oidc | iam] 选择权限提供者来担任管道执行角色。默认值为 iam
--oidc-provider-url TEXT OIDC 提供商的网址。值必须以开头https://
--oidc-client-id TEXT 为您的 OIDC 提供商配置的客户端 ID。
--github-org TEXT 存储库所属的 GitHub 组织。如果不存在任何组织,请输入存储库所有者的用户名。此选项特定于使用 GitHub操作 OIDC 获取权限。
--github-repo TEXT 将进行部署的 GitHub 存储库的名称。此选项特定于使用 GitHub 操作 OIDC 获取权限。
--deployment-branch TEXT 将进行部署的分支的名称。此选项特定于使用 GitHub 操作 OIDC 获取权限。
--oidc-provider [github-actions | gitlab | bitbucket-pipelines] 将用于 OIDC 权限的 CI/CD 提供商的名称。 GitLab GitHub、和 Bitbucket 均受支持。
--gitlab-group TEXT 存储库所属的 GitLab 组。此选项特定于使用 GitLab OIDC 获取权限。
--gitlab-project TEXT GitLab 项目名称。此选项特定于使用 GitLab OIDC 获取权限。
--bitbucket-repo-uuid TEXT

Bitbucket 存储库的 UUID。此选项特定于使用 Bitbucket OIDC 获取权限。

注意

这个值可以在 https://bitbucket.org/ w orkspac e/rep os itory /admin/admin/pipelines/openid-connect 上找到

cicd-provider TEXT 管道的 CI/CD 平台。Amazon SAM
--debug 开启调试日志记录并打印Amazon SAMCLI生成的调试消息,并显示时间戳。
--profile TEXT 您的凭证文件中用于获取Amazon凭证的特定个人资料。
--region TEXT 要部署到的Amazon区域。例如,us-east-1
-h, --help 显示此消息并退出。

问题排查

错误:缺少必填参数

--no-interactive如果--use-oidc-provider与一起指定但未提供任何必需的参数,则将显示此错误消息以及对缺少参数的描述。