“AWS CDK 引导”操作 YAML - Amazon CodeCatalyst

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

“AWS CDK 引导”操作 YAML

下面是 AWS CDK 引导操作的 YAML 定义。要了解如何使用此操作,请参阅使用工作流程引导 AWS CDK 应用程序

此操作定义部分包含在更广泛的工作流定义文件中。有关此文件的更多信息,请参阅工作流 YAML 定义

注意

接下来的大多数 YAML 属性在可视化编辑器中都有对应的 UI 元素。要查找 UI 元素,请使用 Ctrl+F。该元素将与其关联的 YAML 属性一起列出。

# The workflow definition starts here. # See 顶级属性 for details. Name: MyWorkflow SchemaVersion: 1.0 Actions: # The action definition starts here. CDKBootstrapAction_nn: Identifier: aws/cdk-bootstrap@v2 DependsOn: - action-name Compute: Type: EC2 | Lambda Fleet: fleet-name Timeout: timeout-minutes Inputs: # Specify a source or an artifact, but not both. Sources: - source-name-1 Artifacts: - artifact-name Outputs: Artifacts: - Name: cdk_bootstrap_artifacts Files: - "cdk.out/**/*" Environment: Name: environment-name Connections: - Name: account-connection-name Role: iam-role-name Configuration: Region: us-west-2 CdkCliVersion: version

CDKBootstrapAction

(必需)

指定操作的名称。工作流中的所有操作名称都必须是唯一的。操作名称仅限于字母数字字符(a-z、A-Z、0-9)、连字符(-)和下划线(_)。不允许使用空格。不能使用引号在操作名称中包含特殊字符和空格。

默认值:CDKBootstrapAction_nn

对应的 UI:“配置”选项卡/操作显示名称

Identifier

(CDKBootstrapAction/Identifier)

(必需)

标识操作。除非您要更改版本,否则不要更改此属性。有关更多信息,请参阅 指定要使用的操作版本

注意

指定 aws/cdk-bootstrap@v2 可以让操作在 2024 年 3 月版映像上运行,其中包括较新的工具,例如 Node.js 18。指定 aws/cdk-bootstrap@v1 可以让操作在 2022 年 11 月版映像上运行,其中包括较旧的工具,例如 Node.js 16。

默认值:aws/cdk-bootstrap@v2

对应的 UI:工作流图表/CDKBootstrapAction_nn/aws/cdk-bootstrap@v2 标签

DependsOn

(CDKBootstrapAction/DependsOn)

(可选)

指定必须成功运行才能使该操作运行的操作、操作组或阶段门。

有关“依赖于”功能的更多信息,请参阅顺序操作

对应的 UI:“输入”选项卡/依赖于 – 可选

Compute

(CDKBootstrapAction/Compute)

(可选)

用于运行工作流操作的计算引擎。您可以在工作流级别或操作级别指定计算,但不能同时在这两个级别指定计算。在工作流级别指定计算时,计算配置将应用于工作流中定义的所有操作。在工作流级别,您还可以在同一个实例上运行多个操作。有关更多信息,请参阅跨操作共享计算

对应的 UI:

Type

(CDKBootstrapAction/Compute/Type)

(如果包含 Compute,则为必需)

计算引擎的类型。可以使用下列值之一:

  • EC2(可视化编辑器)或EC2(YAML 编辑器)

    已经过优化,提高了操作运行期间的灵活性。

  • Lambda(可视化编辑器)或 Lambda(YAML 编辑器)

    优化了操作启动速度。

有关计算类型的更多信息,请参阅计算类型

相应的 UI:配置 tab/Advanced -可选/计算类型

Fleet

(CDKBootstrapAction/Compute/Fleet)

(可选)

指定将运行您的工作流或工作流操作的计算机或实例集。对于按需实例集,当操作开始时,工作流会预置操作所需的资源,操作完成后计算机就会被销毁。按需实例集的示例:Linux.x86-64.LargeLinux.x86-64.XLarge。有关按需实例集的更多信息,请参阅按需实例集属性

使用预置的实例集,您可以配置一组专用计算机来运行工作流操作。这些计算机保持空闲状态,可随时开始立即处理操作。有关预置实例集的更多信息,请参阅预置实例集属性

如果省略 Fleet,则默认值为 Linux.x86-64.Large

相应的 UI:配置 tab/Advanced -可选/计算舰队

Timeout

(CDKBootstrapAction/Timeout)

(必需)

指定操作在 CodeCatalyst 结束操作之前可以运行的时间(以分钟(YAML 编辑器)或小时和分钟(可视化编辑器)为单位。最小值为 5 分钟,最大值如 中的工作流程配额 CodeCatalyst 中描述。默认超时值与最大超时值相同。

对应的 UI:“配置”选项卡/超时 – 可选

Inputs

(CDKBootstrapAction/Inputs)

(可选)

Inputs 部分中定义了工作流运行期间 AWS CDK 引导操作所需的数据。

对应的 UI:输入选项卡

注意

每个 AWS CDK 引导操作只能有一个输入(可以是源或构件)。

Sources

(CDKBootstrapAction/Inputs/Sources)

(如果您的 AWS CDK 应用程序存储在源存储库中,则为必填项)

如果您的 AWS CDK 应用程序存储在源存储库中,请指定该源存储库的标签。在启动引导过程之前,AWS CDK 引导操作会合成此存储库中的应用程序。目前唯一支持的存储库标签是 WorkflowSource

如果您的 AWS CDK 应用程序不包含在源存储库中,则它必须位于另一个操作生成的构件中。

有关来源的更多信息,请参阅将源存储库连接到工作流

对应的 UI:“输入”选项卡/来源 – 可选

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

(如果您的 AWS CDK 应用程序存储在先前操作的输出构件中,则为必填项)

如果您的 AWS CDK 应用程序包含在先前操作生成的构件中,请在此处指定该构件。在AWS CDK 启动引导过程之前,bootstrap 操作会将指定工件中的应用程序合成到 CloudFormation 模板中。如果您的 AWS CDK 应用程序不包含在构件中,则必须驻留在您的源存储库中。

有关构件的更多信息(包括示例),请参阅在操作之间共享构件和文件

对应的 UI:“输入”选项卡/构件 – 可选

Outputs

(CDKBootstrapAction/Outputs)

(可选)

定义在工作流运行期间操作输出的数据。

对应的 UI:输出选项卡

Artifacts - output

(CDKBootstrapAction/Outputs/Artifacts)

(可选)

指定操作生成的构件。您可以在其他操作中将这些构件作为输入来引用。

有关构件的更多信息(包括示例),请参阅在操作之间共享构件和文件

对应的 UI:“输出”选项卡/构件

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

(如果包含 Artifacts - output,则为必需)

指定将包含在运行时由AWS CDK 引导操作合成的 AWS CloudFormation 模板的工件的名称。默认值为 cdk_bootstrap_artifacts。如果您未指定构件,则该操作会合成模板,但不会将模板保存在构件中。考虑将合成的模板保存在构件中,以便保留其记录,供测试或故障排除之用。

对应的用户界面:输出tab/Artifacts/Add构件/构建构件名称

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

(如果包含 Artifacts - output,则为必需)

指定要包含在构件中的文件。您"cdk.out/**/*"必须指定包含 AWS CDK 应用程序的合成 AWS CloudFormation 模板。

注意

cdk.out 是保存已合成文件的默认目录。如果您指定了输出目录,而不是 cdk.json 文件中的 cdk.out,请在此处指定该目录,而不是 cdk.out

相应的 UI:输出tab/Artifacts/Add构件/编译生成的文件

Environment

(CDKBootstrapAction/Environment)

(必需)

指定要用于操作的 CodeCatalyst 环境。该操作连接到在所选环境中指定的 AWS 账户 和可选的 Amazon VPC。该操作使用环境中指定的默认 IAM 角色连接到 AWS 账户,并使用在 A mazon VPC 连接中指定的 IAM 角色连接到亚马逊 VPC。

注意

如果默认 IAM 角色不具有操作所需的权限,则可以将操作配置为使用其他角色。有关更多信息,请参阅更改操作的 IAM 角色

有关环境的更多信息,请参阅部署到 AWS 账户 和 VPCs创建环境

对应的 UI:“配置”选项卡/环境

Name

(CDKBootstrapAction/Environment/Name)

(如果包含 Environment,则为必需)

指定要与操作关联的现有环境的名称。

对应的 UI:“配置”选项卡/环境

Connections

(CDKBootstrapAction/Environment/Connections)

(在新版本的操作中为可选;在旧版本中为必需)

指定要与操作关联的账户连接。您在 Environment 下最多只能指定一个账户连接。

如果您不指定账户连接:

  • 该操作使用 CodeCatalyst 控制台中环境中指定的 AWS 账户 连接和默认 IAM 角色。有关向环境添加账户连接和默认 IAM 角色的信息,请参阅创建环境

  • 默认 IAM 角色必须包含操作所需的策略和权限。要具体确定这些策略和权限,请参阅操作的 YAML 定义文档中 Role 属性的描述。

有关账户连接的更多信息,请参阅允许在已连接的情况下访问 AWS 资源 AWS 账户。有关向环境添加账户连接的信息,请参阅创建环境

对应的 UI:根据操作版本的不同,为下列项之一:

  • (新版本)配置tab/Environment/What在my-environment吗? /三点菜单/ 切换角色

  • (旧版本)配置选项卡/ Environment/account/role ''/账户连接AWS

Name

(CDKBootstrapAction/Environment/Connections/Name)

(如果包含 Connections,则为必需)

指定账户连接的名称。

对应的 UI:根据操作版本的不同,为下列项之一:

  • (新版本)配置tab/Environment/What在my-environment吗? /三点菜单/ 切换角色

  • (旧版本)配置选项卡/ Environment/account/role ''/账户连接AWS

Role

(CDKBootstrapAction/Environment/Connections/Role)

(如果包含 Connections,则为必需)

指定引导操作用于访问 AWS 和添加AWS CDK 引导堆栈的 IAM 角色的名称。请确保您已将该角色添加到您的 CodeCatalyst 空间,并且该角色包含以下策略。

如果您未指定 IAM 角色,则该操作将使用 CodeCatalyst 控制台中环境中列出的默认 IAM 角色。如果您在环境中使用默认角色,请确保其具有相应的策略。

如果需要,可以在此操作中使用 CodeCatalystWorkflowDevelopmentRole-spaceName 角色。有关该角色的更多信息,请参阅为您的账户和空间创建 CodeCatalystWorkflowDevelopmentRole-spaceName 角色。了解 CodeCatalystWorkflowDevelopmentRole-spaceName 角色具有完全访问权限可能会带来安全风险。我们建议您仅在教程和安全要求较低的场景中使用此角色。

对应的 UI:根据操作版本的不同,为下列项之一:

  • (新版本)配置tab/Environment/What在my-environment吗? /三点菜单/ 切换角色

  • (旧版本)“配置” 选项卡/' '/ 角色 Environment/account/role

Configuration

(CDKBootstrapAction/Configuration)

(必需)

可在其中定义操作的配置属性的部分。

对应的 UI:配置选项卡

Region

(CDKBootstrapAction/Configuration/Region)

(必需)

指定要部署 AWS 区域 引导堆栈的。该区域应与您的 AWS CDK 应用程序部署的区域相匹配。有关区域代码的列表,请参阅区域端点

对应的 UI:“配置”选项卡/区域

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(可选)

此属性适用于 AWS CDK 部署操作的 1.0.13 或更高版本,以及 AWS CDK 引导操作的 1.0.8 或更高版本。

指定下列项之一:

  • 您希望此操作使用的 AWS Cloud Development Kit (AWS CDK) 命令行界面 (CLI)(也称为 AWS CDK 工具包)的完整版本。示例:2.102.1。在构建和部署您的应用程序时,请考虑指定完整版本,从而确保一致性和稳定性。

  • latest。请考虑指定 latest,从而利用 CDK CLI 的最新功能和修复。

该操作会将指定版本(或最新版本)的 AWS CDK CLI 下载到 CodeCatalyst 构建映像,然后使用此版本运行部署 CDK 应用程序或引导环境所需的命令。 AWS

有关可使用的受支持 CDK CLI 版本的列表,请参阅 AWS CDK 版本

如果省略此属性,则该操作将使用以下主题之一中描述的默认 AWS CDK CLI 版本:

对应的 UI:“配置” 选项卡/ AWS CDK CLI 版本