本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
sam pipeline bootstrap
此页面提供了 Amazon Serverless Application Model 命令行界面 (Amazon SAM CLI) sam local pipeline bootstrap
子命令的参考信息。
有关 Amazon SAM CLI 的简介,请参阅 那是什么 Amazon SAMCLI?。
sam pipeline bootstrap
子命令会生成连接到 CI/CD 系统所需的 Amazon 基础设施资源。在运行 sam pipeline init 命令之前,必须针对管道中的每个部署阶段运行此步骤。
此子命令设置以下 Amazon 基础设施资源:
-
可选择通过以下方式配置管道权限:
-
与 CI/CD 系统共享访问密钥 ID 和私有密钥访问凭证的管道 IAM 用户。
注意
我们建议定期轮换访问密钥。有关更多信息,请参阅《IAM 用户指南》中的对于需要长期凭证的使用场景定期轮换访问密钥。
-
通过 OIDC 受支持的 CI/CD 平台。有关在 Amazon SAM 管道中使用 OIDC 的介绍,请转到 在 Amazon SAM 管道中使用 OIDC 身份验证。
-
-
由 Amazon CloudFormation 担任以部署 Amazon SAM 应用程序的 Amazon CloudFormation 执行 IAM 角色。
-
用于存放 Amazon SAM 构件的 Amazon S3 存储桶。
-
(可选)用于存放容器映像 Lambda 部署包的 Amazon ECR 映像存储库(如果资源为
Image
包类型)。
使用量
$
sam pipeline bootstrap
<options>
Options
--bitbucket-repo-uuid
TEXT
-
Bitbucket 存储库的 UUID。此选项特定于使用 Bitbucket OIDC 获取权限。
注意
这个值可以在 https://bitbucket.org/ w
orkspac
e/repos
itory /admin/admin/pipelines/openid-connect 上找到 --bucket
TEXT
-
存放 Amazon SAM 构件的 Amazon S3 存储桶的 ARN。
--cicd-provider
TEXT
-
Amazon SAM 管道的 CI/CD 平台。
--cloudformation-execution-role
TEXT
-
部署应用程序堆栈时,Amazon CloudFormation 要担任的 IAM 角色的 ARN。仅当您希望使用自己的角色时提供。否则,该命令将创建一个新角色。
--config-env
TEXT
-
在配置文件中指定要使用的默认参数值的环境名称。默认值为
default
。有关配置文件的详细信息,请参阅 Amazon SAMCLI 配置文件。 --config-file
PATH
-
包含要使用的默认参数值的配置文件的路径和文件名。在项目目录的根目录中,默认值为
samconfig.toml
。有关配置文件的详细信息,请参阅 Amazon SAMCLI 配置文件。 --confirm-changeset | --no-confirm-changeset
-
提示确认资源的部署。
--create-image-repository | --no-create-image-repository
-
如果未提供 Amazon ECR 映像存储库,请指定是否要创建。Amazon ECR 存储库存放 Lambda 函数或包类型为
Image
的层的容器映像。默认值为--no-create-image-repository
。 --debug
-
启用调试日志记录,打印 Amazon SAM CLI 生成的调试消息,并显示时间戳。
--deployment-branch
TEXT
-
将进行部署的分支的名称。此选项特定于使用 GitHub 操作 OIDC 获取权限。
--github-org
TEXT
-
存储库所属的 GitHub 组织。如果不存在任何组织,请输入存储库所有者的用户名。此选项特定于使用 GitHub操作 OIDC 获取权限。
--github-repo
TEXT
-
将进行部署的 GitHub 存储库的名称。此选项特定于使用 GitHub 操作 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
-
与 CI/CD 系统共享其访问密钥 ID 和秘密访问密钥的 IAM 用户的 Amazon 资源名称(ARN)。它用于向此 IAM 用户授予访问相应 Amazon 账户的权限。如果未提供,此命令将创建 IAM 用户以及访问密钥 ID 和秘密访问密钥。
--profile
TEXT
-
凭证文件中用于获取 Amazon 凭证的特定配置文件。
--region
TEXT
-
要部署到的 Amazon Region。例如,
us-east-1
。 --save-params
-
将您在命令行中提供的参数保存到 Amazon SAM 配置文件中。
--stage
TEXT
-
相应部署阶段的名称。它用作创建的 Amazon 基础设施资源的后缀。
故障排除
错误:缺少必需参数
如果指定了 --no-interactive
和 --use-oidc-provider
,但未提供任何必需的参数,则会显示此错误消息以及缺失参数的描述。