CDKBootstrapAction Identifier DependsOn Compute Type Fleet Timeout Inputs Sources Artifacts - input Outputs Artifacts - output Name Files Environment Name Connections Name Role Configuration Region CdkCliVersion

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

(選用)

指定必須成功執行的動作、動作群組或閘道，才能執行此動作。

如需 'depends on' 功能的詳細資訊，請參閱定序動作。

對應的 UI：輸入索引標籤/相依於 - 選用

Compute

(CDKBootstrapAction/Compute)

(選用)

用來執行工作流程動作的運算引擎。您可以在工作流程層級或動作層級指定運算，但不能同時指定兩者。在工作流程層級指定時，運算組態會套用至工作流程中定義的所有動作。在工作流程層級，您也可以在相同的執行個體上執行多個動作。如需詳細資訊，請參閱跨動作共用運算。

對應的 UI：無

Type

(CDKBootstrapAction/Compute/Type)

（如果Compute包含則為必要）

運算引擎的類型。您可以使用下列其中一個值：

EC2 （視覺化編輯器）或 EC2(YAML 編輯器）

最佳化動作執行期間的彈性。
Lambda （視覺化編輯器）或 Lambda(YAML 編輯器）

最佳化動作啟動速度。

如需運算類型的更多相關資訊，請參閱運算類型。

對應的 UI：組態索引標籤/進階 - 選用/運算類型

Fleet

(CDKBootstrapAction/Compute/Fleet)

(選用)

指定將執行工作流程或工作流程動作的機器或機群。使用隨需機群時，當動作開始時，工作流程會佈建所需的資源，並在動作完成時銷毀機器。隨需機群範例：Linux.x86-64.Large、Linux.x86-64.XLarge。如需隨需機群的詳細資訊，請參閱隨需機群屬性。

使用佈建機群，您可以設定一組專用機器來執行工作流程動作。這些機器保持閒置狀態，準備好立即處理動作。如需佈建機群的詳細資訊，請參閱佈建的機群屬性。

如果省略 Fleet ，則預設值為 Linux.x86-64.Large。

對應的 UI：組態索引標籤/進階 - 選用/運算機群

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 引導操作會在啟動引導程序之前，將指定成品中的應用程式合成至 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。如果您未指定成品，則動作會合成範本，但不會將其儲存在成品中。考慮將合成的範本儲存在成品中，以保留記錄以供測試或故障診斷之用。

對應的 UI：輸出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 帳戶，並使用 Amazon VPC 連線中指定的 IAM 角色來連線至 Amazon VPC。

注意

如果預設 IAM 角色沒有動作所需的許可，您可以將動作設定為使用不同的角色。如需詳細資訊，請參閱變更動作的 IAM 角色。

如需環境的詳細資訊，請參閱部署至 AWS 帳戶和 VPCs和建立環境。

對應的 UI：組態索引標籤/環境

Name

(CDKBootstrapAction/Environment/Name)

（如果Environment包含則為必要）

指定您要與動作建立關聯的現有環境名稱。

對應的 UI：組態索引標籤/環境

Connections

(CDKBootstrapAction/Environment/Connections)

（在較新版本的動作中為選用；在較舊版本中為必要）

指定要與動作建立關聯的帳戶連線。您可以在下指定最多一個帳戶連線Environment。

如果您未指定帳戶連線：

動作會使用 CodeCatalyst 主控台中環境指定的 AWS 帳戶連線和預設 IAM 角色。如需將帳戶連線和預設 IAM 角色新增至環境的相關資訊，請參閱建立環境。
預設 IAM 角色必須包含動作所需的政策和許可。若要判斷這些政策和許可是什麼，請參閱動作 YAML 定義文件中角色屬性的描述。

如需帳戶連線的詳細資訊，請參閱允許存取已連線 AWS 的資源 AWS 帳戶。如需將帳戶連線新增至環境的相關資訊，請參閱建立環境。

對應的 UI：取決於動作版本，下列其中一項：

（較新版本）組態tab/Environment/What是 my-environment？/三個點選單/切換角色
（舊版本）組態索引標籤/'Environment/account/role'/AWS account connection

Name

(CDKBootstrapAction/Environment/Connections/Name)

（如果Connections包含則為必要）

指定帳戶連線的名稱。

對應的 UI：取決於動作版本，下列其中一項：

（較新版本）組態tab/Environment/What是 my-environment？/三個點選單/切換角色
（舊版本）組態索引標籤/'Environment/account/role'/AWS account 連線

Role

(CDKBootstrapAction/Environment/Connections/Role)

（如果Connections包含則為必要）

指定AWS CDK 引導操作用來存取 AWS 和新增引導堆疊的 IAM 角色名稱。請確定您已將角色新增至 CodeCatalyst 空間，且該角色包含下列政策。

如果您未指定 IAM 角色，則動作會使用 CodeCatalyst 主控台中環境中列出的預設 IAM 角色。如果您在環境中使用預設角色，請確定其具有下列政策。

注意

下列許可政策中顯示的許可是 cdk bootstrap命令在寫入時執行其引導所需的許可。如果變更其引導命令，這些許可可能會 AWS CDK 變更。

警告

僅將此角色與AWS CDK 引導操作搭配使用。它非常寬鬆，而且搭配其他動作使用可能會構成安全風險。

下列許可政策：


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "ssm:GetParameterHistory",
                "ecr:PutImageScanningConfiguration",
                "cloudformation:*",
                "iam:CreateRole",
                "iam:AttachRolePolicy",
                "ssm:GetParameters",
                "iam:PutRolePolicy",
                "ssm:GetParameter",
                "ssm:DeleteParameters",
                "ecr:DeleteRepository",
                "ssm:PutParameter",
                "ssm:DeleteParameter",
                "iam:PassRole",
                "ecr:SetRepositoryPolicy",
                "ssm:GetParametersByPath",
                "ecr:DescribeRepositories",
                "ecr:GetLifecyclePolicy"
            ],
            "Resource": [
                "arn:aws:ssm:aws-region:aws-account:parameter/cdk-bootstrap/*",
                "arn:aws:cloudformation:aws-region:aws-account:stack/CDKToolkit/*",
                "arn:aws:ecr:aws-region:aws-account:repository/cdk-*",
                "arn:aws:iam::aws-account:role/cdk-*"
            ]
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "cloudformation:RegisterType",
                "cloudformation:CreateUploadBucket",
                "cloudformation:ListExports",
                "cloudformation:DescribeStackDriftDetectionStatus",
                "cloudformation:SetTypeDefaultVersion",
                "cloudformation:RegisterPublisher",
                "cloudformation:ActivateType",
                "cloudformation:ListTypes",
                "cloudformation:DeactivateType",
                "cloudformation:SetTypeConfiguration",
                "cloudformation:DeregisterType",
                "cloudformation:ListTypeRegistrations",
                "cloudformation:EstimateTemplateCost",
                "cloudformation:DescribeAccountLimits",
                "cloudformation:BatchDescribeTypeConfigurations",
                "cloudformation:CreateStackSet",
                "cloudformation:ListStacks",
                "cloudformation:DescribeType",
                "cloudformation:ListImports",
                "s3:*",
                "cloudformation:PublishType",
                "ecr:CreateRepository",
                "cloudformation:DescribePublisher",
                "cloudformation:DescribeTypeRegistration",
                "cloudformation:TestType",
                "cloudformation:ValidateTemplate",
                "cloudformation:ListTypeVersions"
            ],
            "Resource": "*"
        }
    ]
}

注意

第一次使用角色時，請在資源政策陳述式中使用下列萬用字元，然後在資源名稱可用後縮小政策的範圍。


"Resource": "*"

下列自訂信任政策：


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

注意

如有需要，您可以使用 CodeCatalystWorkflowDevelopmentRole-spaceName角色搭配此動作。如需有關此角色的詳細資訊，請參閱為您的帳戶和空間建立 CodeCatalystWorkflowDevelopmentRole-spaceName角色。了解該CodeCatalystWorkflowDevelopmentRole-spaceName角色具有完整的存取許可，這可能會構成安全風險。我們建議您只在不太擔心安全性的教學課程和案例中使用此角色。

對應的 UI：取決於動作版本，下列其中一項：

（較新版本）組態tab/Environment/What是 my-environment？/三個點選單/切換角色
（舊版本）組態索引標籤/'Environment/account/role'/Role

Configuration

(CDKBootstrapAction/Configuration)

(必要)

您可以在此區段定義動作的組態屬性。

對應的 UI：組態索引標籤

Region

(CDKBootstrapAction/Configuration/Region)

(必要)

指定要部署引導堆疊的 AWS 區域。此區域應與您的 AWS CDK 應用程式部署所在的區域相符。如需區域代碼清單，請參閱區域端點。

對應的 UI：組態索引標籤/區域

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(選用)

此屬性適用於 1.0.13 版或更新版本的AWS CDK 部署動作，以及 1.0.8 版或更新版本的AWS CDK 引導動作。

請指定下列其中一項：

您希望此動作使用的 AWS Cloud Development Kit (AWS CDK) 命令列界面 (CLI) （也稱為 AWS CDK Toolkit) 完整版本。範例：2.102.1。請考慮指定完整版本，以確保建置和部署應用程式時的一致性和穩定性。

或
latest。考慮指定 latest以利用 CDK CLI 的最新功能和修正。

動作會將指定的 CLI AWS CDK 版本（或最新版本）下載至 CodeCatalyst 建置映像，然後使用此版本來執行部署 CDK 應用程式或引導環境 AWS 所需的命令。

如需您可以使用的支援 CDK CLI 版本清單，請參閱AWS CDK 版本。

如果您省略此屬性，動作會使用下列其中一個主題所述的預設 AWS CDK CLI 版本：

對應的 UI：組態索引標籤/AWS CDK CLI 版本

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

變數 - 'AWS CDK bootstrap' 動作

發佈至 Amazon S3