Amazon CodeCatalyst 不再向新客戶開放。現有客戶可以繼續正常使用該服務。如需詳細資訊，請參閱[如何從 CodeCatalyst 遷移](migration.md)。

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

# 使用工作流程部署
<a name="deploy"></a>



使用 [CodeCatalyst 工作流程](workflow.md)，您可以將應用程式和其他資源部署到 Amazon ECS 等各種目標 AWS Lambda。

## 如何部署應用程式？
<a name="deploy-concepts"></a>

若要透過 CodeCatalyst 部署應用程式或資源，您必須先建立工作流程，然後在其中指定部署動作。*部署動作*是工作流程建置區塊，可定義您要部署*的內容*、您要部署*的位置*，以及您想要部署*的方式* （例如，使用藍/綠方案）。您可以使用 CodeCatalyst 主控台的視覺化編輯器或 YAML 編輯器，將部署動作新增至工作流程。

部署應用程式或資源的高階步驟如下所示。

**部署應用程式 （高階任務）**

1. 在 CodeCatalyst 專案中，您可以為要部署的應用程式**新增原始程式碼**。如需詳細資訊，請參閱[將原始程式碼存放在 CodeCatalyst 中專案的儲存庫中](source-repositories.md)。

1. 在 CodeCatalyst 專案中，您可以**新增環境**，定義您要部署的目標 AWS 帳戶 和選用 Amazon Virtual Private Cloud (VPC)。如需詳細資訊，請參閱[部署至 AWS 帳戶 和 VPCs](deploy-environments.md)。

1. 在 CodeCatalyst 專案中，您可以**建立工作流程**。工作流程是您定義如何建置、測試和部署應用程式的地方。如需詳細資訊，請參閱[工作流程入門](workflows-getting-started.md)。

1. 在工作流程中，您可以**新增觸發**條件、**建置動作**，以及選擇性**的測試動作**。如需詳細資訊，請參閱[使用觸發程序自動啟動工作流程執行](workflows-add-trigger.md)、[新增建置動作](build-add-action.md)及[新增測試動作](test-add-action.md)。

1. 在工作流程中，您可以**新增部署動作**。您可以從數個 CodeCatalyst 提供的部署動作中選擇到應用程式的不同目標，例如 Amazon ECS。（您也可以使用建置動作或 GitHub 動作來部署應用程式。 如需建置動作和 GitHub 動作的詳細資訊，請參閱 [部署動作的替代方案](#deploy-concepts-alternatives)。)

1. 您可以透過觸發手動或自動**啟動工作流程**。工作流程會依序執行建置、測試和部署動作，將您的應用程式和資源部署到目標。如需詳細資訊，請參閱[手動啟動工作流程執行](workflows-manually-start.md)。

## 部署動作的清單
<a name="deploy-concepts-action-supported"></a>

下列部署動作可供使用：
+ 部署 CloudFormation 堆疊 – 此動作 AWS 會根據您提供的[CloudFormation 範本](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification.html)，在 中建立 CloudFormation [AWS Serverless Application Model](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html) 堆疊。如需詳細資訊，請參閱[部署 CloudFormation 堆疊](deploy-action-cfn.md)。
+ 部署到 Amazon ECS – 此動作會註冊您提供[的任務定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html#welcome-task-definitions)檔案。如需詳細資訊，請參閱[使用工作流程部署至 Amazon ECS](deploy-action-ecs.md)。
+ 部署至 Kubernetes 叢集 – 此動作會將應用程式部署至 Amazon Elastic Kubernetes Service 叢集。如需詳細資訊，請參閱[使用工作流程部署至 Amazon EKS](deploy-action-eks.md)。
+ AWS CDK 部署 – 此動作會將[AWS CDK 應用程式](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_concepts)部署到 AWS。如需詳細資訊，請參閱[使用工作流程部署 AWS CDK 應用程式](cdk-dep-action.md)。

**注意**  
還有其他 CodeCatalyst 動作可以部署資源；不過，這些動作不會被視為*部署*動作，因為其部署資訊不會出現在**環境**頁面上。若要進一步了解**環境**頁面和檢視部署，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)和 [檢視部署資訊](deploy-view-deployment-info.md)。

## 部署動作的優點
<a name="deploy-concepts-why-use"></a>

在工作流程中使用部署動作具有下列優點：
+ **部署歷史記錄** – 檢視部署的歷史記錄，以協助管理和傳達部署軟體中的變更。
+ 可**追蹤性** – 透過 CodeCatalyst 主控台追蹤部署的狀態，並查看每個應用程式修訂版的部署時間和位置。
+ **回復** – 發生錯誤時自動回復部署。您也可以設定警示來啟用部署轉返。
+ **監控** – 在部署進行工作流程的各個階段時觀察部署。
+ **與其他 CodeCatalyst 功能的整合** – 儲存原始程式碼，然後建置、測試和部署它，全都從單一應用程式完成。

## 部署動作的替代方案
<a name="deploy-concepts-alternatives"></a>

您不需要使用部署動作，但建議使用這些動作，因為它們提供上一節中概述的優點。反之，您可以使用下列 [CodeCatalyst 動作](workflows-actions.md#workflows-actions-types-cc)：
+ **建置**動作。

  一般而言，如果您想要部署到不存在對應部署動作的目標，或者想要對部署程序進行更多控制，您可以使用建置動作。如需使用建置動作部署資源的詳細資訊，請參閱 [使用工作流程建置](build-workflow-actions.md)。
+ **GitHub 動作**。

  您可以在 CodeCatalyst 工作流程中使用 [GitHub 動作](workflows-actions.md#workflows-actions-types-github)來部署應用程式和資源 （而不是 CodeCatalyst 動作）。如需如何在 CodeCatalyst 工作流程中使用 GitHub 動作的詳細資訊，請參閱 [與 GitHub 動作整合](integrations-github-actions.md)

如果您不想使用 CodeCatalyst 工作流程，您也可以使用下列 AWS 服務來部署應用程式：
+ AWS CodeDeploy – 請參閱[什麼是 CodeDeploy？](https://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html)
+ AWS CodeBuild 和 AWS CodePipeline – 請參閱[什麼是 AWS CodeBuild？](https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html) [什麼是 AWS CodePipeline？](https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html)
+ CloudFormation – 請參閱[什麼是 CloudFormation？](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)

針對複雜的企業部署，使用 CodeDeploy、CodeBuild、CodePipeline 和 CloudFormation 服務。

**Topics**
+ [如何部署應用程式？](#deploy-concepts)
+ [部署動作的清單](#deploy-concepts-action-supported)
+ [部署動作的優點](#deploy-concepts-why-use)
+ [部署動作的替代方案](#deploy-concepts-alternatives)
+ [使用工作流程部署至 Amazon ECS](deploy-action-ecs.md)
+ [使用工作流程部署至 Amazon EKS](deploy-action-eks.md)
+ [部署 CloudFormation 堆疊](deploy-action-cfn.md)
+ [使用工作流程部署 AWS CDK 應用程式](cdk-dep-action.md)
+ [使用工作流程引導 AWS CDK 應用程式](cdk-boot-action.md)
+ [使用工作流程將檔案發佈至 Amazon S3](s3-pub-action.md)
+ [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)
+ [在工作流程圖表中顯示應用程式 URL](deploy-app-url.md)
+ [移除部署目標](deploy-remove-target.md)
+ [依遞交追蹤部署狀態](track-changes.md)
+ [檢視部署日誌](deploy-deployment-logs.md)
+ [檢視部署資訊](deploy-view-deployment-info.md)

# 使用工作流程部署至 Amazon ECS
<a name="deploy-action-ecs"></a>

本節說明如何使用 CodeCatalyst 工作流程將容器化應用程式部署至 Amazon Elastic Container Service 叢集。若要達成此目的，您必須將**部署至 Amazon ECS** 動作新增至工作流程。此動作會註冊您提供[的任務定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html#welcome-task-definitions)檔案。註冊時，任務定義會由 [Amazon ECS 叢集中執行的 Amazon ECS 服務](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html)執行個體化。 [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html#welcome-clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html#welcome-clusters)「建立任務定義」等同於將應用程式部署到 Amazon ECS。

若要使用此動作，您必須備妥 Amazon ECS 叢集、服務和任務定義檔案。

如需 Amazon ECS 的詳細資訊，請參閱《*Amazon Elastic Container Service 開發人員指南*》。

**提示**  
如需說明如何使用**部署至 Amazon ECS **動作的教學課程，請參閱 [教學課程：將應用程式部署至 Amazon ECS](deploy-tut-ecs.md)。

**提示**  
如需**部署至 Amazon ECS** 動作的工作範例，請使用 **Node.js API 搭配 AWS Fargate** 或 **Java API 搭配 AWS Fargate**藍圖來建立專案。如需詳細資訊，請參閱[使用藍圖建立專案](projects-create.md#projects-create-console-template)。

**Topics**
+ [「部署至 Amazon ECS」動作所使用的執行期映像](#deploy-action-ecs-runtime)
+ [教學課程：將應用程式部署至 Amazon ECS](deploy-tut-ecs.md)
+ [將 'Deploy 新增至 Amazon ECS' 動作](deploy-action-ecs-adding.md)
+ [「部署到 Amazon ECS」變數](deploy-action-ecs-variables.md)
+ [「部署到 Amazon ECS」動作 YAML](deploy-action-ref-ecs.md)

## 「部署至 Amazon ECS」動作所使用的執行期映像
<a name="deploy-action-ecs-runtime"></a>

**部署至 Amazon ECS** 動作會在 [2022 年 11 月映像](build-images.md#build.previous-image)上執行。如需詳細資訊，請參閱[作用中映像](build-images.md#build-curated-images)。

# 教學課程：將應用程式部署至 Amazon ECS
<a name="deploy-tut-ecs"></a>

在本教學課程中，您將了解如何使用工作流程、Amazon ECS 和其他一些 AWS 服務，將無伺服器應用程式部署至 Amazon Elastic Container Service (Amazon ECS)。部署的應用程式是建置在 Apache Web 伺服器 Docker 映像上的簡單 Hello World 網站。本教學課程會逐步解說必要的準備工作，例如設定叢集，然後說明如何建立工作流程來建置和部署應用程式。

**提示**  
您可以使用藍圖，為您完成 Amazon ECS 設定，而不是透過本教學課程進行。您需要使用 **Node.js API 搭配 AWS Fargate** 或 **Java API 搭配 AWS Fargate**藍圖。如需詳細資訊，請參閱[使用藍圖建立專案](projects-create.md#projects-create-console-template)。

**Topics**
+ [先決條件](#deploy-tut-ecs-prereqs)
+ [步驟 1：設定 AWS 使用者和 AWS CloudShell](#deploy-tut-ecs-user-cloudshell)
+ [步驟 2：將預留位置應用程式部署至 Amazon ECS](#deploy-tut-ecs-placeholder)
+ [步驟 3：建立 Amazon ECR 映像儲存庫](#deploy-tut-ecs-ecr)
+ [步驟 4：建立 AWS 角色](#deploy-tut-ecs-build-deploy-roles)
+ [步驟 5：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-ecs-import-roles)
+ [步驟 6：建立來源儲存庫](#deploy-tut-ecs-source-repo)
+ [步驟 7：新增來源檔案](#deploy-tut-ecs-source-files)
+ [步驟 8：建立和執行工作流程](#deploy-tut-ecs-workflow)
+ [步驟 9：變更來源檔案](#deploy-tut-ecs-change)
+ [清除](#deploy-tut-ecs-cleanup)

## 先決條件
<a name="deploy-tut-ecs-prereqs"></a>

開始之前：
+ 您需要具有連線 AWS 帳戶的 CodeCatalyst **空間**。如需詳細資訊，請參閱[建立空間](spaces-create.md)。
+ 在您的空間中，您需要一個名為 的空專案：

  ```
  codecatalyst-ecs-project
  ```

  使用**從頭開始**選項來建立此專案。

  如需詳細資訊，請參閱[在 Amazon CodeCatalyst 中建立空專案](projects-create.md#projects-create-empty)。
+ 在您的專案中，您需要名為 的 CodeCatalyst **環境**：

  ```
  codecatalyst-ecs-environment
  ```

  設定此環境，如下所示：
  + 選擇任何類型的，例如**非生產**。
  + 將您的帳戶連接到該 AWS 帳戶。
  + 針對**預設 IAM 角色**，選擇任何角色。稍後您將指定不同的角色。

  如需詳細資訊，請參閱[部署至 AWS 帳戶 和 VPCs](deploy-environments.md)。

## 步驟 1：設定 AWS 使用者和 AWS CloudShell
<a name="deploy-tut-ecs-user-cloudshell"></a>

本教學課程的第一步是在 中建立使用者 AWS IAM Identity Center，並以此使用者身分啟動 AWS CloudShell 執行個體。在本教學課程中，CloudShell 是您的開發電腦，也是您設定 AWS 資源和服務的地方。完成教學課程後刪除此使用者。

**注意**  
請勿將您的根使用者用於本教學課程。稍後在 AWS Command Line Interface (CLI) 中執行動作時，您必須建立個別的使用者，否則可能會遇到問題。

如需 IAM Identity Center 使用者和 CloudShell 的詳細資訊，請參閱 *AWS IAM Identity Center 使用者指南*和 *AWS CloudShell 使用者指南*。

**建立 IAM Identity Center 使用者**

1. 登入 AWS 管理主控台 ，並在 https：//[https://console.aws.amazon.com/singlesignon/](https://console.aws.amazon.com/singlesignon/) 開啟 AWS IAM Identity Center 主控台。
**注意**  
請務必使用連線至 CodeCatalyst 空間 AWS 帳戶 的 登入。您可以透過導覽至您的空間並選擇 **AWS 帳戶索引標籤來驗證哪個帳戶**已連線。如需詳細資訊，請參閱[建立空間](spaces-create.md)。

1. 在導覽窗格中，選擇 **使用者**，然後選擇 **新增使用者**。

1. 在**使用者名稱**中，輸入：

   ```
   CodeCatalystECSUser
   ```

1. 在**密碼**下，選擇**產生您可以與此使用者共用的一次性密碼**。

1. 在**電子郵件地址**和**確認電子郵件地址**中，輸入 IAM Identity Center 中尚不存在的電子郵件地址。

1. 在**名字**和**姓氏**中，輸入：

   ```
   CodeCatalystECSUser
   ```

1. 在**顯示名稱**中，保留自動產生的名稱：

   ```
   CodeCatalystECSUser CodeCatalystECSUser
   ```

1. 選擇**下一步**。

1. 在**新增使用者至群組**頁面上，選擇**下一步**。

1. 在**檢閱和新增使用者**頁面上，檢閱資訊，然後選擇**新增使用者**。

   **一次性密碼**對話方塊隨即出現。

1. 選擇**複製**，然後貼上登入資訊，包括 AWS 存取入口網站 URL 和一次性密碼。

1. 選擇**關閉**。

**建立許可集合**

您將將此許可集指派給`CodeCatalystECSUser`稍後的 。

1. 在導覽窗格中，選擇**許可集**，然後選擇**建立許可集**。

1. 選擇**預先定義的許可集**，然後選取 **AdministratorAccess**。此政策為所有 提供完整許可 AWS 服務。

1. 選擇**下一步**。

1. 在**許可集名稱**中，輸入：

   ```
   CodeCatalystECSPermissionSet
   ```

1. 選擇**下一步**。

1. 在**檢閱和建立**頁面上，檢閱資訊，然後選擇**建立**。

**將許可集指派給 CodeCatalystECSUser**

1. 在導覽窗格中，選擇 **AWS 帳戶**，然後選取 AWS 帳戶 您目前登入之 旁的核取方塊。

1. 選擇**指派使用者或群組**。

1. 選擇**使用者**索引標籤。

1. 選取 旁的核取方塊`CodeCatalystECSUser`。

1. 選擇**下一步**。

1. 選取 旁的核取方塊`CodeCatalystECSPermissionSet`。

1. 選擇**下一步**。

1. 檢閱資訊，然後選擇**提交**。

   您現在已將 `CodeCatalystECSUser`和 `CodeCatalystECSPermissionSet` 指派給 AWS 帳戶，並將其繫結在一起。

**以 CodeCatalystECSUser 身分登出並重新登入**

1. 登出之前，請確定您擁有 AWS 存取入口網站 URL 以及 的使用者名稱和一次性密碼`CodeCatalystECSUser`。您應該稍早已將此資訊複製到文字編輯器。
**注意**  
如果您沒有此資訊，請前往 IAM Identity Center 的詳細資訊`CodeCatalystECSUser`頁面，選擇**重設密碼**、**產生一次性密碼 【...】** 和再次**重設密碼**，以在畫面上顯示資訊。

1. 登出 AWS。

1. 將 AWS 存取入口網站 URL 貼到瀏覽器的地址列。

1. 使用 的使用者名稱和一次性密碼登入`CodeCatalystECSUser`。

1. 在**新密碼**中，輸入密碼，然後選擇**設定新密碼**。

   畫面上會出現一個**AWS 帳戶**方塊。

1. 選擇 **AWS 帳戶**，然後選擇您 AWS 帳戶 為其指派`CodeCatalystECSUser`使用者和許可集的 名稱。

1. 在 旁`CodeCatalystECSPermissionSet`，選擇 **管理主控台**。

    AWS 管理主控台 隨即出現。您現在以`CodeCatalystECSUser`具有適當許可的 身分登入。

**啟動 AWS CloudShell 執行個體**

1. 作為 `CodeCatalystECSUser`，在頂端導覽列中，選擇 AWS 圖示 (![\[AWS icon\]](http://docs.aws.amazon.com/zh_tw/codecatalyst/latest/userguide/images/deploy/aws-logo.png))。

   隨即 AWS 管理主控台 顯示 的主頁面。

1. 在頂端導覽列中，選擇 AWS CloudShell 圖示 (![\[CloudShell icon\]](http://docs.aws.amazon.com/zh_tw/codecatalyst/latest/userguide/images/deploy/CloudShell.png))。

   CloudShell 隨即開啟。等待 CloudShell 環境建立。
**注意**  
如果您沒有看到 CloudShell 圖示，請確定您位於 [ CloudShell 支援的區域中](https://docs.aws.amazon.com/cloudshell/latest/userguide/faq-list.html#regions-available)。本教學假設您位於美國西部 （奧勒岡） 區域。

**驗證 AWS CLI 是否已安裝**

1. 在 CloudShell 終端機中，輸入：

   ```
   aws --version
   ```

1. 檢查版本是否出現。

    AWS CLI 已為目前使用者 設定 `CodeCatalystECSUser`，因此不需要設定 AWS CLI 金鑰和登入資料，通常也是如此。

## 步驟 2：將預留位置應用程式部署至 Amazon ECS
<a name="deploy-tut-ecs-placeholder"></a>

在本節中，您將手動將預留位置應用程式部署至 Amazon ECS。此預留位置應用程式將由工作流程部署的 Hello World 應用程式取代。預留位置應用程式為 Apache Web Server。

如需 Amazon ECS 的詳細資訊，請參閱《*Amazon Elastic Container Service 開發人員指南*》。

完成下列一系列程序以部署預留位置應用程式。<a name="deploy-tut-ecs-create-task-execution-role"></a>

**建立任務執行角色**

此角色會授予 Amazon ECS 和代表您進行 API 呼叫的 AWS Fargate 許可。

1. 建立信任政策：

   1. 在 中 AWS CloudShell，輸入下列命令：

      ```
      cat > codecatalyst-ecs-trust-policy.json
      ```

      CloudShell 終端機中會出現閃爍提示。

   1. 在提示中輸入下列程式碼：

------
#### [ JSON ]

****  

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

------

   1. 將游標放在最後一個大括號 () 之後`}`。

   1. 按 **Enter** ，然後按 **Ctrl\$1d** 儲存檔案並退出貓。

1. 建立任務執行角色：

   ```
   aws iam create-role \
         --role-name codecatalyst-ecs-task-execution-role \
         --assume-role-policy-document file://codecatalyst-ecs-trust-policy.json
   ```

1. 將 AWS 受管`AmazonECSTaskExecutionRolePolicy`政策連接至角色：

   ```
   aws iam attach-role-policy \
         --role-name codecatalyst-ecs-task-execution-role \
         --policy-arn arn:aws:iam::aws:policy/service-role/AmazonECSTaskExecutionRolePolicy
   ```

1. 顯示角色的詳細資訊：

   ```
   aws iam get-role \
         --role-name codecatalyst-ecs-task-execution-role
   ```

1. 請記下角色`"Arn":`的值，例如 `arn:aws:iam::111122223333:role/codecatalyst-ecs-task-execution-role`。稍後您將需要此 Amazon Resource Name (ARN)。

**建立 Amazon ECS 叢集**

此叢集將包含 Apache 預留位置應用程式，以及稍後的 Hello World 應用程式。

1. 作為 `CodeCatalystECSUser`，在 中 AWS CloudShell建立空叢集：

   ```
   aws ecs create-cluster --cluster-name codecatalyst-ecs-cluster
   ```

1. （選用） 確認叢集已成功建立：

   ```
   aws ecs list-clusters
   ```

   `codecatalyst-ecs-cluster` 叢集的 ARN 應該會出現在清單中，表示成功建立。

**建立任務定義檔案**

任務定義檔案指出 要執行從 DockerHub 提取的 [Apache 2.4 Web 伺服器](https://hub.docker.com/_/httpd) Docker 映像 (`httpd:2.4`)。 DockerHub

1. 作為 `CodeCatalystECSUser`，在 中 AWS CloudShell建立任務定義檔案：

   ```
   cat > taskdef.json
   ```

1. 在提示中貼上下列程式碼：

   ```
   {
       "executionRoleArn": "arn:aws:iam::111122223333:role/codecatalyst-ecs-task-execution-role",
       "containerDefinitions": [
           {
               "name": "codecatalyst-ecs-container",
               "image": "httpd:2.4",
               "essential": true,
               "portMappings": [
                   {
                       "hostPort": 80,
                       "protocol": "tcp",
                       "containerPort": 80
                   }
               ]
           }
       ],
       "requiresCompatibilities": [
           "FARGATE"
       ],
       "cpu": "256",
       "family": "codecatalyst-ecs-task-def",
       "memory": "512",
       "networkMode": "awsvpc"
   }
   ```

   在上述程式碼中，取代 *arn：aws：iam：：111122223333：role/codecatalyst-ecs-task-execution-role*

   使用您在 中記下之任務執行角色的 ARN[建立任務執行角色](#deploy-tut-ecs-create-task-execution-role)。

1. 將游標放在最後一個大括號 () 之後`}`。

1. 按 **Enter** ，然後按 **Ctrl\$1d** 儲存檔案並退出貓。

**向 Amazon ECS 註冊任務定義檔案**

1. 作為 `CodeCatalystECSUser`，在 中 AWS CloudShell註冊任務定義：

   ```
   aws ecs register-task-definition \
       --cli-input-json file://taskdef.json
   ```

1. （選用） 確認任務定義已註冊：

   ```
   aws ecs list-task-definitions
   ```

   `codecatalyst-ecs-task-def` 任務定義應該會出現在清單中。

**建立 Amazon ECS 服務**

Amazon ECS 服務會執行 Apache 預留位置應用程式的任務 （和相關聯的 Docker 容器），以及稍後的 Hello World 應用程式。

1. 身為 `CodeCatalystECSUser`，如果您尚未這麼做，請切換到 Amazon Elastic Container Service 主控台。

1. 選擇您先前建立的叢集 `codecatalyst-ecs-cluster`。

1. 在**服務**索引標籤中，選擇**建立**。

1. 在**建立**頁面中，執行下列動作：

   1. 保留所有預設設定，但接下來列出的設定除外。

   1. 針對 **Launch type (啟動類型)**，選擇 **FARGATE**。

   1. 在**任務定義**下，於**系列**下拉式清單中，選擇：

      `codecatalyst-ecs-task-def`

   1. 針對**服務名稱**，輸入：

      ```
      codecatalyst-ecs-service
      ```

   1. 針對**所需的任務**，輸入：

      ```
      3
      ```

      在本教學課程中，每個任務都會啟動單一 Docker 容器。

   1. 展開**聯網**區段。

   1. 對於 **VPC**，請選擇任何 VPC。

   1. 針對**子網路**，選擇任何子網路。
**注意**  
僅指定一個子網路。這就是本教學課程所需的一切。
**注意**  
如果您沒有 VPC 和子網路，請建立它們。請參閱《Amazon [VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#Create-VPC) 使用者指南》中的建立 VPC 和[在您的 VPC 中建立子網路](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#AddaSubnet)。 **

   1. 針對**安全群組**，選擇**建立新的安全群組**，然後執行下列動作：

      1. 針對**安全群組名稱**，輸入：

         ```
         codecatalyst-ecs-security-group
         ```

      1. 針對**安全群組描述**，輸入：

         ```
         CodeCatalyst ECS security group
         ```

      1. 選擇**新增規則**。針對**類型**，選擇 **HTTP**，針對**來源**，選擇 **Anywhere**。

   1. 在底部，選擇**建立**。

   1. 等待服務建立。這可能需要幾分鐘的時間。

1. 選擇**任務**索引標籤，然後選擇重新整理按鈕。確認這三個任務的**上次狀態**欄都設定為**執行**中。

**（選用） 驗證您的 Apache 預留位置應用程式是否正在執行**

1. 在**任務**索引標籤中，選擇三個任務中的任一個。

1. 在**公有 IP** 欄位中，選擇**開啟的地址**。

   `It Works!` 頁面隨即出現。這表示 Amazon ECS 服務已成功啟動使用 Apache 映像啟動 Docker 容器的任務。

   在教學課程中的這個階段，您已手動部署 Amazon ECS 叢集、服務和任務定義，以及 Apache 預留位置應用程式。所有這些項目都就緒後，您現在可以建立工作流程，以教學課程的 Hello World 應用程式取代 Apache 預留位置應用程式。

## 步驟 3：建立 Amazon ECR 映像儲存庫
<a name="deploy-tut-ecs-ecr"></a>

在本節中，您會在 Amazon Elastic Container Registry (Amazon ECR) 中建立私有映像儲存庫。此儲存庫會存放教學課程的 Docker 映像，以取代您先前部署的 Apache 預留位置映像。

如需 Amazon ECR 的詳細資訊，請參閱《*Amazon Elastic Container Registry 使用者指南*》。

**在 Amazon ECR 中建立映像儲存庫**

1. 作為 `CodeCatalystECSUser`，在 中 AWS CloudShell，在 Amazon ECR 中建立空儲存庫：

   ```
   aws ecr create-repository --repository-name codecatalyst-ecs-image-repo
   ```

1. 顯示 Amazon ECR 儲存庫的詳細資訊：

   ```
   aws ecr describe-repositories \
         --repository-names codecatalyst-ecs-image-repo
   ```

1. 請記下 `“repositoryUri”:`值，例如 `111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-ecs-image-repo`。

   稍後在將儲存庫新增至工作流程時需要它。

## 步驟 4：建立 AWS 角色
<a name="deploy-tut-ecs-build-deploy-roles"></a>

在本節中，您會建立 CodeCatalyst AWS 工作流程運作所需的 IAM 角色。這些角色包括：
+ **組建角色** – 授予 CodeCatalyst 組建動作 （在工作流程中） 存取 AWS 您的帳戶和寫入 Amazon ECR 和 Amazon EC2 的許可。
+ **部署角色** – 授予 CodeCatalyst **部署到 ECS** 動作 （在工作流程中） 存取 AWS 您的帳戶、Amazon ECS 和其他一些 AWS 服務的許可。

如需 IAM 角色的詳細資訊，請參閱*AWS Identity and Access Management 《 使用者指南*》中的 [IAM 角色](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)。

**注意**  
若要節省時間，您可以建立稱為角色的單一`CodeCatalystWorkflowDevelopmentRole-spaceName`角色，而不是先前列出的兩個角色。如需詳細資訊，請參閱[為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有非常廣泛的許可，這可能會構成安全風險。我們建議您只在安全性較少的教學課程和案例中使用此角色。本教學假設您正在建立先前列出的兩個角色。

若要建立建置和部署角色，您可以使用 AWS 管理主控台 或 AWS CLI。

------
#### [ AWS 管理主控台 ]

若要建立建置和部署角色，請完成下列一系列程序。

**建立建置角色**

1. 建立角色的政策，如下所示：

   1. 登入 AWS。

   1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。

   1. 在導覽窗格中，選擇**政策**。

   1. 選擇 **Create policy** (建立政策)。

   1. 請選擇 **JSON** 標籤。

   1. 刪除現有的程式碼。

   1. 貼上以下程式碼：

------
#### [ JSON ]

****  

      ```
      {
          "Version":"2012-10-17",		 	 	 
          "Statement": [
              {
                  "Effect": "Allow",
                  "Action": [
                      "ecr:*",
                      "ec2:*"
                  ],
                  "Resource": "*"
              }
          ]
      }
      ```

------
**注意**  
第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元，然後在資源名稱可用之後縮小政策的範圍。  

      ```
      "Resource": "*"
      ```

   1. 選擇下**一步：標籤**。

   1. 選擇下**一步：檢閱**。

   1. 在**名稱**中，輸入：

      ```
      codecatalyst-ecs-build-policy
      ```

   1. 選擇**建立政策**。

      您現在已建立許可政策。

1. 建立建置角色，如下所示：

   1. 在導覽窗格中，選擇**角色**，然後選擇**建立角色**。

   1. 選擇**自訂信任政策**。

   1. 刪除現有的自訂信任政策。

   1. 新增下列自訂信任政策：

   1. 選擇**下一步**。

   1. 在**許可政策**中，搜尋 `codecatalyst-ecs-build-policy`，選取其核取方塊。

   1. 選擇**下一步**。

   1. 針對**角色名稱**，輸入：

      ```
      codecatalyst-ecs-build-role
      ```

   1. 針對**角色描述**，輸入：

      ```
      CodeCatalyst ECS build role
      ```

   1. 選擇建**立角色**。

   您現在已建立具有許可政策和信任政策的建置角色。

1. 取得建置角色 ARN，如下所示：

   1. 在導覽窗格中，選擇**角色**。

   1. 在搜尋方塊中，輸入您剛建立的角色名稱 (`codecatalyst-ecs-build-role`)。

   1. 從清單中選擇角色。

      角色的**摘要**頁面隨即出現。

   1. 在頂端複製 **ARN** 值。供稍後使用。

**建立部署角色**

1. 建立角色的政策，如下所示：

   1. 登入 AWS。

   1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。

   1. 在導覽窗格中，選擇**政策**。

   1. 選擇**建立政策**。

   1. 請選擇 **JSON** 標籤。

   1. 刪除現有的程式碼。

   1. 貼上以下程式碼：

------
#### [ JSON ]

****  

      ```
      {
          "Version":"2012-10-17",		 	 	 
          "Statement": [{
          "Action":[
            "ecs:DescribeServices",
            "ecs:CreateTaskSet",
            "ecs:DeleteTaskSet",
            "ecs:ListClusters",
            "ecs:RegisterTaskDefinition",
            "ecs:UpdateServicePrimaryTaskSet",
            "ecs:UpdateService",
            "elasticloadbalancing:DescribeTargetGroups",
            "elasticloadbalancing:DescribeListeners",
            "elasticloadbalancing:ModifyListener",
            "elasticloadbalancing:DescribeRules",
            "elasticloadbalancing:ModifyRule",
            "lambda:InvokeFunction",
            "lambda:ListFunctions",
            "cloudwatch:DescribeAlarms",
            "sns:Publish",
            "sns:ListTopics", 
            "s3:GetObject",
            "s3:GetObjectVersion",
            "codedeploy:CreateApplication", 
            "codedeploy:CreateDeployment", 
            "codedeploy:CreateDeploymentGroup", 
            "codedeploy:GetApplication", 
            "codedeploy:GetDeployment", 
            "codedeploy:GetDeploymentGroup", 
            "codedeploy:ListApplications", 
            "codedeploy:ListDeploymentGroups", 
            "codedeploy:ListDeployments", 
            "codedeploy:StopDeployment", 
            "codedeploy:GetDeploymentTarget", 
            "codedeploy:ListDeploymentTargets", 
            "codedeploy:GetDeploymentConfig", 
            "codedeploy:GetApplicationRevision", 
            "codedeploy:RegisterApplicationRevision", 
            "codedeploy:BatchGetApplicationRevisions", 
            "codedeploy:BatchGetDeploymentGroups", 
            "codedeploy:BatchGetDeployments", 
            "codedeploy:BatchGetApplications", 
            "codedeploy:ListApplicationRevisions", 
            "codedeploy:ListDeploymentConfigs", 
            "codedeploy:ContinueDeployment"           
         ],
         "Resource":"*",
         "Effect":"Allow"
      },{"Action":[
            "iam:PassRole"
         ],
         "Effect":"Allow",
         "Resource":"*",
         "Condition":{"StringLike":{"iam:PassedToService":[
                  "ecs-tasks.amazonaws.com",
                  "codedeploy.amazonaws.com"
               ]
            }
         }
      }]
      }
      ```

------
**注意**  
第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元。之後，您可以使用資源名稱縮小政策的範圍。  

      ```
      "Resource": "*"
      ```

   1. 選擇下**一步：標籤**。

   1. 選擇下**一步：檢閱**。

   1. 在**名稱**中，輸入：

      ```
      codecatalyst-ecs-deploy-policy
      ```

   1. 選擇**建立政策**。

      您現在已建立許可政策。

1. 建立部署角色，如下所示：

   1. 在導覽窗格中，選擇**角色**，然後選擇**建立角色**。

   1. 選擇**自訂信任政策**。

   1. 刪除現有的自訂信任政策。

   1. 新增下列自訂信任政策：

   1. 選擇**下一步**。

   1. 在**許可政策**中，搜尋 `codecatalyst-ecs-deploy-policy`，選取其核取方塊。

   1. 選擇**下一步**。

   1. 針對**角色名稱**，輸入：

      ```
      codecatalyst-ecs-deploy-role
      ```

   1. 針對**角色描述**，輸入：

      ```
      CodeCatalyst ECS deploy role
      ```

   1. 選擇建**立角色**。

   您現在已建立具有信任政策的部署角色。

1. 取得部署角色 ARN，如下所示：

   1. 在導覽窗格中，選擇**角色**。

   1. 在搜尋方塊中，輸入您剛建立的角色名稱 (`codecatalyst-ecs-deploy-role`)。

   1. 從清單中選擇角色。

      角色的**摘要**頁面隨即出現。

   1. 在頂端複製 **ARN** 值。供稍後使用。

------
#### [ AWS CLI ]

若要建立建置和部署角色，請完成下列一系列程序。

**為兩個角色建立信任政策**

作為 `CodeCatalystECSUser`，在 中 AWS CloudShell建立信任政策檔案：

1. 建立 檔案：

   ```
   cat > codecatalyst-ecs-trust-policy.json
   ```

1. 在終端機提示中，貼上下列程式碼：

1. 將游標放在最後一個大括號 () 之後`}`。

1. 按 **Enter** ，然後按 **Ctrl\$1d** 儲存檔案並退出貓。

**建立建置政策和建置角色**

1. 建立建置政策：

   1. 作為 `CodeCatalystECSUser`，在 中 AWS CloudShell建立建置政策檔案：

      ```
      cat > codecatalyst-ecs-build-policy.json
      ```

   1. 出現提示時，輸入下列程式碼：

------
#### [ JSON ]

****  

      ```
      {
          "Version":"2012-10-17",		 	 	 
          "Statement": [
              {
                  "Effect": "Allow",
                  "Action": [
                      "ecr:*",
                      "ec2:*"
                  ],
                  "Resource": "*"
              }
          ]
      }
      ```

------

   1. 將游標放在最後一個大括號 () 之後`}`。

   1. 按 **Enter** ，然後按 **Ctrl\$1d** 儲存檔案並退出貓。

1. 將建置政策新增至 AWS：

   ```
   aws iam create-policy \
       --policy-name codecatalyst-ecs-build-policy \
       --policy-document file://codecatalyst-ecs-build-policy.json
   ```

1. 在命令輸出中，記下 `"arn":`值，例如 `arn:aws:iam::111122223333:policy/codecatalyst-ecs-build-policy`。您稍後需要此 ARN。

1. 建立建置角色，並將信任政策連接至該角色：

   ```
   aws iam create-role \
         --role-name codecatalyst-ecs-build-role \
         --assume-role-policy-document file://codecatalyst-ecs-trust-policy.json
   ```

1. 將建置政策連接至建置角色：

   ```
   aws iam attach-role-policy \
         --role-name codecatalyst-ecs-build-role \
         --policy-arn arn:aws:iam::111122223333:policy/codecatalyst-ecs-build-policy
   ```

   其中 *arn：aws：iam：：111122223333：policy/codecatalyst-ecs-build-policy* 會取代為您先前記下的建置政策的 ARN。

1. 顯示建置角色的詳細資訊：

   ```
   aws iam get-role \
         --role-name codecatalyst-ecs-build-role
   ```

1. 請記下角色`"Arn":`的值，例如 `arn:aws:iam::111122223333:role/codecatalyst-ecs-build-role`。您稍後需要此 ARN。

**建立部署政策和部署角色**

1. 建立部署政策：

   1. 在 中， AWS CloudShell建立部署政策檔案：

      ```
      cat > codecatalyst-ecs-deploy-policy.json
      ```

   1. 出現提示時，輸入下列程式碼：

------
#### [ JSON ]

****  

      ```
      {
          "Version":"2012-10-17",		 	 	 
          "Statement": [{
          "Action":[
            "ecs:DescribeServices",
            "ecs:CreateTaskSet",
            "ecs:DeleteTaskSet",
            "ecs:ListClusters",
            "ecs:RegisterTaskDefinition",
            "ecs:UpdateServicePrimaryTaskSet",
            "ecs:UpdateService",
            "elasticloadbalancing:DescribeTargetGroups",
            "elasticloadbalancing:DescribeListeners",
            "elasticloadbalancing:ModifyListener",
            "elasticloadbalancing:DescribeRules",
            "elasticloadbalancing:ModifyRule",
            "lambda:InvokeFunction",
            "lambda:ListFunctions",
            "cloudwatch:DescribeAlarms",
            "sns:Publish",
            "sns:ListTopics", 
            "s3:GetObject",
            "s3:GetObjectVersion",
            "codedeploy:CreateApplication", 
            "codedeploy:CreateDeployment", 
            "codedeploy:CreateDeploymentGroup", 
            "codedeploy:GetApplication", 
            "codedeploy:GetDeployment", 
            "codedeploy:GetDeploymentGroup", 
            "codedeploy:ListApplications", 
            "codedeploy:ListDeploymentGroups", 
            "codedeploy:ListDeployments", 
            "codedeploy:StopDeployment", 
            "codedeploy:GetDeploymentTarget", 
            "codedeploy:ListDeploymentTargets", 
            "codedeploy:GetDeploymentConfig", 
            "codedeploy:GetApplicationRevision", 
            "codedeploy:RegisterApplicationRevision", 
            "codedeploy:BatchGetApplicationRevisions", 
            "codedeploy:BatchGetDeploymentGroups", 
            "codedeploy:BatchGetDeployments", 
            "codedeploy:BatchGetApplications", 
            "codedeploy:ListApplicationRevisions", 
            "codedeploy:ListDeploymentConfigs", 
            "codedeploy:ContinueDeployment"           
         ],
         "Resource":"*",
         "Effect":"Allow"
      },{"Action":[
            "iam:PassRole"
         ],
         "Effect":"Allow",
         "Resource":"*",
         "Condition":{"StringLike":{"iam:PassedToService":[
                  "ecs-tasks.amazonaws.com",
                  "codedeploy.amazonaws.com"
               ]
            }
         }
      }]
      }
      ```

------
**注意**  
第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元，然後在資源名稱可用後縮小政策範圍。  

      ```
      "Resource": "*"
      ```

   1. 將游標放在最後一個大括號 () 之後`}`。

   1. 按 **Enter** ，然後按 **Ctrl\$1d** 儲存檔案並退出貓。

1. 將部署政策新增至 AWS：

   ```
   aws iam create-policy \
       --policy-name codecatalyst-ecs-deploy-policy \
       --policy-document file://codecatalyst-ecs-deploy-policy.json
   ```

1. 在命令輸出中，記下部署政策`"arn":`的值，例如 `arn:aws:iam::111122223333:policy/codecatalyst-ecs-deploy-policy`。您稍後需要此 ARN。

1. 建立部署角色，並將信任政策連接至該角色：

   ```
   aws iam create-role \
         --role-name codecatalyst-ecs-deploy-role \
         --assume-role-policy-document file://codecatalyst-ecs-trust-policy.json
   ```

1. 將部署政策連接至部署角色，其中 *arn：aws：iam：：111122223333：policy/codecatalyst-ecs-deploy-policy* 會取代為您先前記下的部署政策的 ARN。

   ```
   aws iam attach-role-policy \
         --role-name codecatalyst-ecs-deploy-role \
         --policy-arn arn:aws:iam::111122223333:policy/codecatalyst-ecs-deploy-policy
   ```

1. 顯示部署角色的詳細資訊：

   ```
   aws iam get-role \
         --role-name codecatalyst-ecs-deploy-role
   ```

1. 請記下角色`"Arn":`的值，例如 `arn:aws:iam::111122223333:role/codecatalyst-ecs-deploy-role`。您稍後需要此 ARN。

------

## 步驟 5：將 AWS 角色新增至 CodeCatalyst
<a name="deploy-tut-ecs-import-roles"></a>

在此步驟中，您將建置角色 (`codecatalyst-ecs-build-role`) 和部署角色 (`codecatalyst-ecs-deploy-role`) 新增至您空間中的 CodeCatalyst 帳戶連線。

**將建置和部署角色新增至您的帳戶連線**

1. 在 CodeCatalyst 中，導覽至您的空間。

1. 選擇**AWS 帳戶**。帳戶連線清單隨即顯示。

1. 選擇代表您建立建置和部署角色 AWS 的帳戶的帳戶連線。

1. **從管理主控台選擇 AWS 管理角色**。

   **將 IAM 角色新增至 Amazon CodeCatalyst 空間**頁面隨即出現。您可能需要登入才能存取頁面。

1. 選取**新增您在 IAM 中建立的現有角色**。

   下拉式清單隨即出現。清單會顯示具有信任政策的所有 IAM 角色，其中包含 `codecatalyst-runner.amazonaws.com``codecatalyst.amazonaws.com`和服務主體。

1. 在下拉式清單中，選擇 `codecatalyst-ecs-build-role`，然後選擇**新增角色**。
**注意**  
如果您看到 `The security token included in the request is invalid`，可能是因為您沒有適當的許可。若要修正此問題，請以您建立 CodeCatalyst 空間時使用 AWS 的帳戶重新登入 AWS 。

1. 選擇**新增 IAM 角色**，選擇**新增您在 IAM 中建立的現有角色**，然後在下拉式清單中選擇 `codecatalyst-ecs-deploy-role`。選擇 **Add role (新增角色)**。

   您現在已將建置和部署角色新增至您的空間。

1. 複製 **Amazon CodeCatalyst 顯示名稱**的值。稍後建立工作流程時，您將需要此值。

## 步驟 6：建立來源儲存庫
<a name="deploy-tut-ecs-source-repo"></a>

在此步驟中，您會在 CodeCatalyst 中建立來源儲存庫。此儲存庫會存放教學課程的來源檔案，例如任務定義檔案。

如需來源儲存庫的詳細資訊，請參閱 [建立來源儲存庫](source-repositories-create.md)。

**建立來源儲存庫**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 導覽至您的專案 `codecatalyst-ecs-project`。

1. 在導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**。

1. 選擇**新增儲存庫**，然後選擇**建立儲存庫**。

1. 在**儲存庫名稱**中，輸入：

   ```
   codecatalyst-ecs-source-repository
   ```

1. 選擇**建立**。

## 步驟 7：新增來源檔案
<a name="deploy-tut-ecs-source-files"></a>

在本節中，您將 Hello World 來源檔案新增至 CodeCatalyst 儲存庫 `codecatalyst-ecs-source-repository`。它們包含：
+ `index.html` 檔案 – 在瀏覽器中顯示 Hello World 訊息。
+ Dockerfile – 描述要用於 Docker 映像的基本映像，以及要套用的 Docker 命令。
+ `taskdef.json` 檔案 – 定義在叢集中啟動任務時要使用的 Docker 映像。

資料夾結構如下所示：

```
.
|— public-html
|  |— index.html
|— Dockerfile
|— taskdef.json
```

**注意**  
下列指示說明如何使用 CodeCatalyst 主控台新增檔案，但您可以視需要使用 Git。如需詳細資訊，請參閱[複製來源儲存庫](source-repositories-clone.md)。

**Topics**
+ [index.html](#deploy-tut-ecs-source-files-index)
+ [Dockerfile](#deploy-tut-ecs-source-files-dockerfile)
+ [taskdef.json](#deploy-tut-ecs-source-files-taskdef)

### index.html
<a name="deploy-tut-ecs-source-files-index"></a>

`index.html` 檔案會在瀏覽器中顯示 Hello World 訊息。

**新增 index.html 檔案**

1. 在 CodeCatalyst 主控台中，前往您的來源儲存庫 `codecatalyst-ecs-source-repository`。

1. 在**檔案中**，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   public-html/index.html
   ```
**重要**  
請務必包含 `public-html/`字首，以建立相同名稱的資料夾。`index.html` 預期會位於此資料夾中。

1. 在文字方塊中，輸入下列程式碼：

   ```
   <html>
     <head>
       <title>Hello World</title>
       <style>
         body {
         background-color: black;
         text-align: center;
         color: white;
         font-family: Arial, Helvetica, sans-serif;
         }  
       </style>
     </head>
     <body>
       <h1>Hello World</h1>
     </body>
   </html>
   ```

1. 選擇**遞交**，然後再次選擇**遞交**。

   `index.html` 會新增至`public-html`資料夾中的儲存庫。

### Dockerfile
<a name="deploy-tut-ecs-source-files-dockerfile"></a>

Dockerfile 說明要使用的基本 Docker 映像，以及要套用的 Docker 命令。如需 Dockerfile 的詳細資訊，請參閱 [Dockerfile 參考](https://docs.docker.com/engine/reference/builder/)。

此處指定的 Dockerfile 表示使用 Apache 2.4 基礎映像 (`httpd`)。它還包含將名為 的來源檔案複製到提供網頁之 Apache 伺服器上`index.html`資料夾的說明。Dockerfile 中的`EXPOSE`說明會告知 Docker 容器正在接聽連接埠 80。

**新增 Dockerfile**

1. 在來源儲存庫中，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   Dockerfile
   ```

   請勿包含副檔名。
**重要**  
Dockerfile 必須位於儲存庫的根資料夾中。工作流程的 `Docker build`命令預期會存在。

1. 在文字方塊中，輸入下列程式碼：

   ```
   FROM httpd:2.4
   COPY ./public-html/index.html /usr/local/apache2/htdocs/index.html
   EXPOSE 80
   ```

1. 選擇**遞交**，然後再次選擇**遞交**。

   Dockerfile 會新增至您的儲存庫。

### taskdef.json
<a name="deploy-tut-ecs-source-files-taskdef"></a>

您在此步驟中新增的檔案與您已在 中指定的`taskdef.json`檔案相同，差異[步驟 2：將預留位置應用程式部署至 Amazon ECS](#deploy-tut-ecs-placeholder)如下：

這裡的任務定義會使用幾個變數來表示影像： `$REPOSITORY_URI`和 ，而不是在 `image:` 欄位 (`httpd:2.4`) 中指定硬式編碼的 Docker 影像名稱`$IMAGE_TAG`。當您在後續步驟中執行工作流程時，工作流程建置動作所產生的實際值會取代這些變數。

如需任務定義參數的詳細資訊，請參閱《*Amazon Elastic Container Service 開發人員指南*》中的[任務定義參數](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html)。

**新增 taskdef.json 檔案**

1. 在來源儲存庫中，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   taskdef.json
   ```

1. 在文字方塊中，輸入下列程式碼：

   ```
   {
       "executionRoleArn": "arn:aws:iam::account_ID:role/codecatalyst-ecs-task-execution-role",
       "containerDefinitions": [
           {
               "name": "codecatalyst-ecs-container",
               # The $REPOSITORY_URI and $IMAGE_TAG variables will be replaced 
               # by the workflow at build time (see the build action in the 
               # workflow)
               "image": $REPOSITORY_URI:$IMAGE_TAG,
               "essential": true,
               "portMappings": [
                   {
                       "hostPort": 80,
                       "protocol": "tcp",
                       "containerPort": 80
                   }
               ]
           }
       ],
       "requiresCompatibilities": [
           "FARGATE"
       ],
       "networkMode": "awsvpc",
       "cpu": "256",
       "memory": "512",
       "family": "codecatalyst-ecs-task-def"
   }
   ```

   在上述程式碼中，取代

   *arn：aws：iam：：account\$1ID：role/codecatalyst-ecs-task-execution-role*

   使用您在 中記下之任務執行角色的 ARN[建立任務執行角色](#deploy-tut-ecs-create-task-execution-role)。

1. 選擇**遞交**，然後再次選擇**遞交**。

   `taskdef.json` 檔案會新增至您的儲存庫。

## 步驟 8：建立和執行工作流程
<a name="deploy-tut-ecs-workflow"></a>

在此步驟中，您會建立工作流程來取得來源檔案、將其建置到 Docker 映像中，然後將映像部署到您的 Amazon ECS 叢集。此部署會取代現有的 Apache 預留位置應用程式。

工作流程包含下列依順序執行的建置區塊：
+ 觸發條件 – 當您將變更推送至來源儲存庫時，此觸發條件會自動啟動工作流程執行。關於觸發條件的詳細資訊，請參閱 [使用觸發程序自動啟動工作流程執行](workflows-add-trigger.md)。
+ 建置動作 (`BuildBackend`) – 觸發時，動作會使用 Dockerfile 建置 Docker 映像，並將映像推送至 Amazon ECR。建置動作也會`taskdef.json`使用正確的`image`欄位值更新 ，然後建立此檔案的輸出成品。此成品會用作部署動作的輸入，接下來是 。

  如需建置動作的詳細資訊，請參閱 [使用工作流程建置](build-workflow-actions.md)。
+ 部署動作 (`DeployToECS`) – 完成建置動作後，部署動作會尋找建置動作 (`TaskDefArtifact`) 產生的輸出成品、尋找`taskdef.json`其中的 ，並向您的 Amazon ECS 服務註冊。然後，服務會遵循 `taskdef.json` 檔案中的指示，在您的 Amazon ECS 叢集內執行三個 Amazon ECS 任務，以及相關聯的 Hello World Docker 容器。

**建立工作流程**

1. 在 CodeCatalyst 主控台的導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇**建立工作流程**。

1. 針對**來源儲存庫**，選擇 `codecatalyst-ecs-source-repository`。

1. 針對**分支**，選擇 `main`。

1. 選擇**建立**。

1. 刪除 YAML 範例程式碼。

1. 新增下列 YAML 程式碼：
**注意**  
在後續的 YAML 程式碼中，您可以視需要省略這些`Connections:`區段。如果您省略這些區段，您必須確保環境中**預設 IAM 角色**欄位中指定的角色包含 中所述兩個角色的許可和信任政策[步驟 5：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-ecs-import-roles)。如需使用預設 IAM 角色設定環境的詳細資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

   ```
   Name: codecatalyst-ecs-workflow
   SchemaVersion: 1.0
   
   Triggers:
     - Type: PUSH
       Branches:
         - main
   Actions:
     BuildBackend:
       Identifier: aws/build@v1
       Environment:
         Name: codecatalyst-ecs-environment
         Connections:
           - Name: codecatalyst-account-connection
             Role: codecatalyst-ecs-build-role
       Inputs:
         Sources:
           - WorkflowSource
         Variables:
           - Name: REPOSITORY_URI
             Value: 111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-ecs-image-repo
           - Name: IMAGE_TAG
             Value: ${WorkflowSource.CommitId}
       Configuration:
         Steps:
           #pre_build:
           - Run: echo Logging in to Amazon ECR...
           - Run: aws --version
           - Run: aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin 111122223333.dkr.ecr.us-west-2.amazonaws.com
           #build:
           - Run: echo Build started on `date`
           - Run: echo Building the Docker image...
           - Run: docker build -t $REPOSITORY_URI:latest .
           - Run: docker tag $REPOSITORY_URI:latest $REPOSITORY_URI:$IMAGE_TAG
           #post_build:
           - Run: echo Build completed on `date`
           - Run: echo Pushing the Docker images...
           - Run: docker push $REPOSITORY_URI:latest
           - Run: docker push $REPOSITORY_URI:$IMAGE_TAG
           # Replace the variables in taskdef.json
           - Run: find taskdef.json -type f | xargs sed -i "s|\$REPOSITORY_URI|$REPOSITORY_URI|g"
           - Run: find taskdef.json -type f | xargs sed -i "s|\$IMAGE_TAG|$IMAGE_TAG|g"
           - Run: cat taskdef.json
           # The output artifact will be a zip file that contains a task definition file.
       Outputs:
         Artifacts:
           - Name: TaskDefArtifact
             Files: 
               - taskdef.json
     DeployToECS:
       DependsOn: 
         - BuildBackend
       Identifier: aws/ecs-deploy@v1
       Environment:
         Name: codecatalyst-ecs-environment
         Connections:
           - Name: codecatalyst-account-connection
             Role: codecatalyst-ecs-deploy-role
       Inputs:
         Sources: []
         Artifacts:
           - TaskDefArtifact
       Configuration:
         region: us-west-2
         cluster: codecatalyst-ecs-cluster
         service: codecatalyst-ecs-service
         task-definition: taskdef.json
   ```

   在上述程式碼中，取代：
   + 兩個 *codecatalyst-ecs-environment* 執行個體，其名稱為您在 中建立的環境[先決條件](#deploy-tut-ecs-prereqs)。
   + 這兩個 *codecatalyst-account-connection* 執行個體都具有您帳戶連線的顯示名稱。顯示名稱可能是數字。如需詳細資訊，請參閱[步驟 5：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-ecs-import-roles)。
   + *codecatalyst-ecs-build-role*，內含您在 中建立的建置角色名稱[步驟 4：建立 AWS 角色](#deploy-tut-ecs-build-deploy-roles)。
   + *111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-ecs-image-repo* （在 `Value:` 屬性中），其中包含您在 中建立的 Amazon ECR 儲存庫的 URI[步驟 3：建立 Amazon ECR 映像儲存庫](#deploy-tut-ecs-ecr)。
   + *111122223333.dkr.ecr.us-west-2.amazonaws.com* （在 `Run: aws ecr`命令中），不含映像尾碼 () 的 Amazon ECR 儲存庫的 URI`/codecatalyst-ecs-image-repo`。
   + *codecatalyst-ecs-deploy-role*，內含您在 中建立的部署角色名稱[步驟 4：建立 AWS 角色](#deploy-tut-ecs-build-deploy-roles)。
   + 使用 AWS 區域碼的 *us-west-2* 這兩個執行個體。如需區域代碼清單，請參閱《》中的[區域端點](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints)*AWS 一般參考*。
**注意**  
如果您決定不建立建置和部署角色，請將 *codecatalyst-ecs-build-role* 和 *codecatalyst-ecs-deploy-role* 取代為`CodeCatalystWorkflowDevelopmentRole-spaceName`角色的名稱。如需有關此角色的詳細資訊，請參閱 [步驟 4：建立 AWS 角色](#deploy-tut-ecs-build-deploy-roles)。
**提示**  
您可以使用**轉譯 Amazon ECS 任務定義**動作來更新儲存庫和映像名稱，而不是使用先前工作流程程式碼中顯示的 和 `find``sed`命令。如需詳細資訊，請參閱[修改 Amazon ECS 任務定義](render-ecs-action.md)。

1. （選用） 選擇**驗證**，以確保 YAML 程式碼在遞交之前有效。

1. 選擇 **Commit** (遞交)。

1. 在**遞交工作流程**對話方塊中，輸入下列內容：

   1. 針對**遞交訊息**，移除文字並輸入：

      ```
      Add first workflow
      ```

   1. 針對**儲存庫**，選擇 `codecatalyst-ecs-source-repository`。

   1. 針對**分支名稱**，選擇主要。

   1. 選擇 **Commit** (遞交)。

   您現在已建立工作流程。由於工作流程頂端定義的觸發條件，工作流程執行會自動啟動。具體而言，當您將`workflow.yaml`檔案遞交 （並推送） 到您的來源儲存庫時，觸發會啟動工作流程執行。

**檢視工作流程執行進度**

1. 在 CodeCatalyst 主控台的導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇您剛建立的工作流程 `codecatalyst-ecs-workflow`。

1. 選擇 **BuildBackend** 以查看建置進度。

1. 選擇 **DeployToECS** 以查看部署進度。

   如需檢視執行詳細資訊的詳細資訊，請參閱 [檢視工作流程執行狀態和詳細資訊](workflows-view-run.md)。

**驗證部署**

1. 開啟 Amazon ECS 傳統主控台，網址為 [https://console.aws.amazon.com/ecs/](https://console.aws.amazon.com/ecs/)。

1. 選擇您的叢集 `codecatalyst-ecs-cluster`。

1. 選擇 **Tasks** (任務) 索引標籤。

1. 選擇三個任務中的任一個。

1. 在**公有 IP** 欄位中，選擇**開啟的地址**。

   瀏覽器中會出現「Hello World」頁面，指出 Amazon ECS 服務已成功部署您的應用程式。

## 步驟 9：變更來源檔案
<a name="deploy-tut-ecs-change"></a>

在本節中，您會變更來源儲存庫中的 `index.html` 檔案。此變更會導致工作流程建立新的 Docker 映像、使用遞交 ID 標記它、將其推送至 Amazon ECR，並將其部署至 Amazon ECS。

**若要變更 index.html**

1. 在 CodeCatalyst 主控台的導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**，然後選擇您的儲存庫 `codecatalyst-ecs-source-repository`。

1. 選擇 `public-html` (下一步)，然後選擇 `index.html` (完成)。

   內容`index.html`隨即出現。

1. 選擇**編輯**。

1. 在第 14 行，將`Hello World`文字變更為 `Tutorial complete!`。

1. 選擇**遞交**，然後再次選擇**遞交**。

   遞交會導致新的工作流程執行開始。

1. （選用） 前往來源儲存庫的主頁面，選擇**檢視遞交**，然後記下`index.html`變更的遞交 ID。

1. 觀看部署進度：

   1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

   1. 選擇 `codecatalyst-ecs-workflow`以檢視最新的執行。

   1. 選擇 **BuildBackend** 和 **DeployToECS** 以查看工作流程執行進度。

1. 確認您的應用程式已更新，如下所示：

   1. 開啟 Amazon ECS 傳統主控台，網址為 [https://console.aws.amazon.com/ecs/](https://console.aws.amazon.com/ecs/)。

   1. 選擇您的叢集 `codecatalyst-ecs-cluster`。

   1. 選擇 **Tasks** (任務) 索引標籤。

   1. 選擇三個任務中的任一個。

   1. 在**公有 IP** 欄位中，選擇**開啟的地址**。

      `Tutorial complete!` 頁面隨即出現。

1. （選用） 在 中 AWS，切換至 Amazon ECR 主控台，並確認新的 Docker 映像已使用步驟 6 的遞交 ID 標記。

## 清除
<a name="deploy-tut-ecs-cleanup"></a>

清除本教學課程中使用的檔案和服務，以避免收取這些檔案和服務的費用。

在 中 AWS 管理主控台，依此順序清除：

1. 在 Amazon ECS 中，執行下列動作：

   1. 刪除 `codecatalyst-ecs-service`。

   1. 刪除 `codecatalyst-ecs-cluster`。

   1. 取消註冊 `codecatalyst-ecs-task-definition`。

1. 在 Amazon ECR 中，刪除 `codecatalyst-ecs-image-repo`。

1. 在 Amazon EC2 中，刪除 `codecatalyst-ecs-security-group`。

1. 在 IAM Identity Center 中，刪除：

   1. `CodeCatalystECSUser`

   1. `CodeCatalystECSPermissionSet`

在 CodeCatalyst 主控台中，如下所示進行清除：

1. 刪除 `codecatalyst-ecs-workflow`。

1. 刪除 `codecatalyst-ecs-environment`。

1. 刪除 `codecatalyst-ecs-source-repository`。

1. 刪除 `codecatalyst-ecs-project`。

在本教學課程中，您已了解如何使用 CodeCatalyst 工作流程和部署至 Amazon ECS 動作，將應用程式**部署至 Amazon ECS** 服務。

# 將 'Deploy 新增至 Amazon ECS' 動作
<a name="deploy-action-ecs-adding"></a>

使用下列指示將**部署至 Amazon ECS** 動作新增至您的工作流程。

------
#### [ Visual ]

**使用視覺化編輯器將 'Deploy 新增至 Amazon ECS' 動作**

1. 開啟 CodeCatalyst 主控台，網址為 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/)。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中選擇 **Amazon CodeCatalyst**。

1. 搜尋**部署至 Amazon ECS** 動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**部署到 Amazon ECS**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**下載**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 在**輸入**和**組態**索引標籤中，根據您的需求完成欄位。如需每個欄位的說明，請參閱 [「部署到 Amazon ECS」動作 YAML](deploy-action-ref-ecs.md)。此參考提供在 YAML 和視覺化編輯器中顯示的每個欄位 （和對應的 YAML 屬性值） 的詳細資訊。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------
#### [ YAML ]

**使用 YAML 編輯器將 'Deploy 新增至 Amazon ECS' 動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋**部署至 Amazon ECS** 動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**部署到 Amazon ECS**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**下載**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 根據您的需求修改 YAML 程式碼中的屬性。中提供了每個可用屬性的說明[「部署到 Amazon ECS」動作 YAML](deploy-action-ref-ecs.md)。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------

# 「部署到 Amazon ECS」變數
<a name="deploy-action-ecs-variables"></a>

**部署至 Amazon ECS** 動作會在執行時間產生並設定下列變數。這些稱為*預先定義的變數*。

如需在工作流程中參考這些變數的資訊，請參閱 [使用預先定義的變數](workflows-using-predefined-variables.md)。


| 金鑰 | 值 | 
| --- | --- | 
|  叢集  |  在工作流程執行期間部署至 的 Amazon ECS 叢集名稱。 範例：`codecatalyst-ecs-cluster`  | 
|  deployment-platform  |  部署平台的名稱。 硬式編碼為 `AWS:ECS`。  | 
|  服務  |  在工作流程執行期間部署至 的 Amazon ECS 服務名稱。 範例：`codecatalyst-ecs-service`  | 
|  task-definition-arn  |  在工作流程執行期間註冊之任務定義的 Amazon Resource Name (ARN)。 範例：`arn:aws:ecs:us-west-2:111122223333:task-definition/codecatalyst-task-def:8`上述範例中`:8`的 表示已註冊的修訂。  | 
|  deployment-url  |  Amazon ECS 主控台**事件**索引標籤的連結，您可以在其中檢視與工作流程執行相關聯的 Amazon ECS 部署詳細資訊。 範例：`https://console.aws.amazon.com/ecs/home?region=us-west-2#/clusters/codecatalyst-ecs-cluster/services/codecatalyst-ecs-service/events`  | 
|  region  |  在工作流程執行期間 AWS 區域 部署至 的 區域碼。 範例：`us-west-2`  | 

# 「部署到 Amazon ECS」動作 YAML
<a name="deploy-action-ref-ecs"></a>

以下是**部署至 Amazon ECS **動作的 YAML 定義。若要了解如何使用此動作，請參閱 [使用工作流程部署至 Amazon ECS](deploy-action-ecs.md)。

此動作定義以區段形式存在於更廣泛的工作流程定義檔案中。如需有關此檔案的詳細資訊，請參閱[工作流程 YAML 定義](workflow-reference.md)。

**注意**  
下列大多數 YAML 屬性在視覺化編輯器中都有對應的 UI 元素。若要查詢 UI 元素，請使用 **Ctrl\$1F**。 元素將與其相關聯的 YAML 屬性一起列出。

```
# The workflow definition starts here.
# See 最上層屬性 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.   
  ECSDeployAction\$1nn: 
    Identifier: aws/ecs-deploy@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - task-definition-artifact
    Configuration: 
      region: us-east-1 
      cluster: ecs-cluster
      service: ecs-service
      task-definition: task-definition-path
      force-new-deployment: false|true
      codedeploy-appspec: app-spec-file-path
      codedeploy-application: application-name
      codedeploy-deployment-group: deployment-group-name
      codedeploy-deployment-description: deployment-description
```

## ECSDeployAction
<a name="deploy.action.ecs.name"></a>

(必要)

指定動作的名稱。工作流程中的所有動作名稱都必須是唯一的。動作名稱僅限於英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (\$1)。不允許空格。您無法使用引號在動作名稱中啟用特殊字元和空格。

預設：`ECSDeployAction_nn`。

對應的 UI：組態索引標籤/**動作顯示名稱**

## Identifier
<a name="deploy.action.ecs.identifier"></a>

(*ECSDeployAction*/**Identifier**)

(必要)

識別 動作。除非您想要變更版本，否則請勿變更此屬性。如需詳細資訊，請參閱[指定要使用的動作版本](workflows-action-versions.md)。

預設：`aws/ecs-deploy@v1`。

對應的 UI：工作流程圖表/ECSDeployAction\$1nn/**aws/ecs-deploy@v1** 標籤

## DependsOn
<a name="deploy.action.ecs.dependson"></a>

(*ECSDeployAction*/**DependsOn**)

(選用)

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

如需 'depends on' 功能的詳細資訊，請參閱 [定序動作](workflows-depends-on.md)。

對應的 UI：輸入索引標籤/**取決於 - 選用**

## Compute
<a name="deploy.action.ecs.computename"></a>

(*ECSDeployAction*/**Compute**)

(選用)

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

對應的 UI：*無*

## Type
<a name="deploy.action.ecs.computetype"></a>

(*ECSDeployAction*/Compute/**Type**)

（如果[Compute](#deploy.action.ecs.computename)包含 則為必要）

運算引擎的類型。您可以使用下列其中一個值：
+ **EC2** （視覺化編輯器） 或 `EC2`(YAML 編輯器）

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

  最佳化的動作啟動速度。

如需運算類型的更多相關資訊，請參閱[運算類型](workflows-working-compute.md#compute.types)。

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

## Fleet
<a name="deploy.action.ecs.computefleet"></a>

(*ECSDeployAction*/Compute/**Fleet**)

(選用)

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

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

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

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

## Timeout
<a name="deploy.action.ecs.timeout"></a>

(*ECSDeployAction*/**Timeout**)

(選用)

指定動作在 CodeCatalyst 結束動作之前可執行的時間，以分鐘為單位 (YAML 編輯器） 或小時和分鐘為單位。最小值為 5 分鐘，最大值如 中所述[CodeCatalyst 中工作流程的配額](workflows-quotas.md)。預設逾時與最大逾時相同。

對應的 UI：組態索引標籤/**逾時 - 選用 **

## Environment
<a name="deploy.action.ecs.environment"></a>

(*ECSDeployAction*/**Environment**)

(必要)

指定要與 動作搭配使用的 CodeCatalyst 環境。動作會連線至所選環境中指定的 AWS 帳戶 和選用 Amazon VPC。動作會使用環境中指定的預設 IAM 角色來連線至 AWS 帳戶，並使用 [Amazon VPC 連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)中指定的 IAM 角色來連線至 Amazon VPC。

**注意**  
如果預設 IAM 角色沒有 動作所需的許可，您可以將動作設定為使用不同的角色。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

如需環境的詳細資訊，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)和 [建立環境](deploy-environments-creating-environment.md)。

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

## Name
<a name="deploy.action.ecs.environment.name"></a>

(*ECSDeployAction*/Environment/**Name**)

（如果[Environment](#deploy.action.ecs.environment)包含 則為必要）

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

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

## Connections
<a name="deploy.action.ecs.environment.connections"></a>

(*ECSDeployAction*/Environment/**Connections**)

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

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

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

如需帳戶連線的詳細資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。如需將帳戶連線新增至環境的相關資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Name
<a name="deploy.action.ecs.environment.connections.name"></a>

(*ECSDeployAction*/Environment/Connections/**Name**)

（如果[Connections](#deploy.action.ecs.environment.connections)包含 則為必要）

指定帳戶連線的名稱。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What*我的環境*是什麼？/三個點選單/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/ **AWS 帳戶連線**

## Role
<a name="deploy.action.ecs.environment.connections.role"></a>

(*ECSDeployAction*/Environment/Connections/**Role**)

（如果[Connections](#deploy.action.ecs.environment.connections)包含 則為必要）

指定**部署至 Amazon ECS **動作用來存取的 IAM 角色名稱 AWS。請確定您已[將角色新增至 CodeCatalyst 空間](ipa-connect-account-addroles.md)，且該角色包含下列政策。

如果您未指定 IAM 角色，則動作會使用 CodeCatalyst 主控台中[環境中](deploy-environments.md)列出的預設 IAM 角色。如果您在環境中使用預設角色，請確定其具有下列政策。
+ 下列許可政策：
**警告**  
將許可限制為下列政策中顯示的許可。使用具有更廣泛許可的角色可能會帶來安全風險。

------
#### [ JSON ]

****  

  ```
  {
      "Version":"2012-10-17",		 	 	 
      "Statement": [{
      "Action":[
        "ecs:DescribeServices",
        "ecs:CreateTaskSet",
        "ecs:DeleteTaskSet",
        "ecs:ListClusters",
        "ecs:RegisterTaskDefinition",
        "ecs:UpdateServicePrimaryTaskSet",
        "ecs:UpdateService",
        "elasticloadbalancing:DescribeTargetGroups",
        "elasticloadbalancing:DescribeListeners",
        "elasticloadbalancing:ModifyListener",
        "elasticloadbalancing:DescribeRules",
        "elasticloadbalancing:ModifyRule",
        "lambda:InvokeFunction",
        "lambda:ListFunctions",
        "cloudwatch:DescribeAlarms",
        "sns:Publish",
        "sns:ListTopics", 
        "s3:GetObject",
        "s3:GetObjectVersion",
        "codedeploy:CreateApplication", 
        "codedeploy:CreateDeployment", 
        "codedeploy:CreateDeploymentGroup", 
        "codedeploy:GetApplication", 
        "codedeploy:GetDeployment", 
        "codedeploy:GetDeploymentGroup", 
        "codedeploy:ListApplications", 
        "codedeploy:ListDeploymentGroups", 
        "codedeploy:ListDeployments", 
        "codedeploy:StopDeployment", 
        "codedeploy:GetDeploymentTarget", 
        "codedeploy:ListDeploymentTargets", 
        "codedeploy:GetDeploymentConfig", 
        "codedeploy:GetApplicationRevision", 
        "codedeploy:RegisterApplicationRevision", 
        "codedeploy:BatchGetApplicationRevisions", 
        "codedeploy:BatchGetDeploymentGroups", 
        "codedeploy:BatchGetDeployments", 
        "codedeploy:BatchGetApplications", 
        "codedeploy:ListApplicationRevisions", 
        "codedeploy:ListDeploymentConfigs", 
        "codedeploy:ContinueDeployment"           
     ],
     "Resource":"*",
     "Effect":"Allow"
  },{"Action":[
        "iam:PassRole"
     ],
     "Effect":"Allow",
     "Resource":"*",
     "Condition":{"StringLike":{"iam:PassedToService":[
              "ecs-tasks.amazonaws.com",
              "codedeploy.amazonaws.com"
           ]
        }
     }
  }]
  }
  ```

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

  ```
  "Resource": "*"
  ```
+ 下列自訂信任政策：

**注意**  
如有需要，您可以使用 `CodeCatalystWorkflowDevelopmentRole-spaceName`角色搭配此動作。如需有關此角色的詳細資訊，請參閱 [為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有可能造成安全風險的完整存取許可。我們建議您只在安全性較少的教學課程和案例中使用此角色。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What*我的環境*是什麼？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**Role**

## Inputs
<a name="deploy.action.ecs.inputs"></a>

(*ECSDeployAction*/**Inputs**)

(選用)

`Inputs` 區段定義工作流程執行期間 `ECSDeployAction`所需的資料。

**注意**  
每個**部署到 Amazon ECS **動作只允許一個輸入 （來源或成品）。

對應的 UI：**輸入**索引標籤

## Sources
<a name="deploy.action.ecs.inputs.sources"></a>

(*ECSDeployAction*/Inputs/**Sources**)

（如果您的任務定義檔案存放在來源儲存庫中，則為必要項目）

如果您的任務定義檔案存放在來源儲存庫中，請指定該來源儲存庫的標籤。目前，唯一支援的標籤是 `WorkflowSource`。

如果您的任務定義檔案不包含在來源儲存庫中，它必須位於另一個動作所產生的成品中。

如需來源的詳細資訊，請參閱 [將來源儲存庫連線至工作流程](workflows-sources.md)。

對應的 UI：輸入索引標籤/**來源 - 選用**

## Artifacts - input
<a name="deploy.action.ecs.inputs.artifacts"></a>

(*ECSDeployAction*/Inputs/**Artifacts**)

（如果您的任務定義檔案存放在先前動作的[輸出成品](workflows-working-artifacts-output.md)中，則為必要）

如果您要部署的任務定義檔案包含在先前動作產生的成品中，請在此處指定該成品。如果您的任務定義檔案不包含在成品中，它必須位於您的來源儲存庫中。

如需成品的詳細資訊，包括範例，請參閱 [在動作之間共用成品和檔案](workflows-working-artifacts.md)。

對應的 UI：組態索引標籤/**成品 - 選用**

## Configuration
<a name="deploy.action.ecs.configuration"></a>

(*ECSDeployAction*/**Configuration**)

(必要)

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

對應的 UI：**組態**索引標籤

## region
<a name="deploy.action.ecs.region"></a>

(Configuration/**region**)

(必要)

指定 Amazon ECS 叢集和服務所在的 AWS 區域。如需區域代碼的清單，請參閱《》中的[區域端點](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints)*AWS 一般參考*。

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

## cluster
<a name="deploy.action.ecs.cluster"></a>

(*ECSDeployAction*/Configuration/**cluster**)

(必要)

指定現有 Amazon ECS 叢集的名稱。**部署至 Amazon ECS** 動作會將您的容器化應用程式做為任務部署至此叢集。如需 Amazon ECS 叢集的詳細資訊，請參閱《*Amazon Elastic Container Service 開發人員指南*》中的[叢集](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html#welcome-clusters)。

對應的 UI：組態索引標籤/**叢集**

## service
<a name="deploy.action.ecs.service"></a>

(*ECSDeployAction*/Configuration/**service**)

(必要)

指定將執行個體化任務定義檔案的現有 Amazon ECS 服務名稱。此服務必須位於 `cluster` 欄位中指定的叢集下。如需 Amazon ECS 服務的詳細資訊，請參閱《[Amazon Elastic Container Service 開發人員指南》中的 Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) *服務*。

對應的 UI：組態索引標籤/**服務**

## task-definition
<a name="deploy.action.ecs.task.definition"></a>

(*ECSDeployAction*/Configuration/**task-definition**)

(必要)

指定現有任務定義檔案的路徑。如果檔案位於您的來源儲存庫中，路徑會與來源儲存庫根資料夾相對。如果您的檔案位於先前工作流程動作的成品中，則路徑會與成品根資料夾相對。如需任務定義檔案的詳細資訊，請參閱《*Amazon Elastic Container Service 開發人員指南*》中的[任務定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html#welcome-task-definitions)。

對應的 UI：組態索引標籤/**任務定義**

## force-new-deployment
<a name="deploy.action.ecs.forcenewdeployment"></a>

(*ECSDeployAction*/Configuration/**force-new-deployment**)

(必要)

如果啟用，Amazon ECS 服務可以在不變更服務定義的情況下啟動新的部署。強制部署會導致服務停止所有目前正在執行的任務，並啟動新任務。如需強制新部署的詳細資訊，請參閱《*Amazon Elastic Container Service 開發人員指南*》中的[更新服務](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service.html)。

預設：`false`

對應的 UI：組態索引標籤/**強制新部署服務**

## codedeploy-appspec
<a name="deploy.action.ecs.codedeploy.appspec"></a>

(*ECSDeployAction*/Configuration/**codedeploy-appspec**)

（如果您已將 Amazon ECS 服務設定為使用藍/綠部署，則此為必要項目，否則請省略）

指定現有 CodeDeploy 應用程式規格 (AppSpec) 檔案的名稱和路徑。此檔案必須位於 CodeCatalyst 來源儲存庫的根目錄。如需 AppSpec 檔案的詳細資訊，請參閱*AWS CodeDeploy 《 使用者指南*》中的 [CodeDeploy 應用程式規格 (AppSpec) 檔案](https://docs.aws.amazon.com/codedeploy/latest/userguide/application-specification-files.html)。

**注意**  
只有在您已將 Amazon ECS 服務設定為執行藍/綠部署時，才提供 CodeDeploy 資訊。對於滾動更新部署 （預設），省略 CodeDeploy 資訊。如需 Amazon ECS 部署的詳細資訊，請參閱《[Amazon Elastic Container Service 開發人員指南》中的 Amazon ECS 部署類型](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)。 **

**注意**  
**CodeDeploy** 欄位可能會隱藏在視覺化編輯器中。若要讓它們出現，請參閱 [為什麼視覺化編輯器中缺少 CodeDeploy 欄位？](troubleshooting-workflows.md#troubleshooting-workflows-codedeploy)。

對應的 UI：組態索引標籤/**CodeDeploy AppSpec**

## codedeploy-application
<a name="deploy.action.ecs.codedeploy.application"></a>

(*ECSDeployAction*/Configuration/**codedeploy-application**)

（如果`codedeploy-appspec`包含 則為必要）

指定現有 CodeDeploy 應用程式的名稱。如需 CodeDeploy 應用程式的詳細資訊，請參閱*AWS CodeDeploy 《 使用者指南*》[中的在 CodeDeploy 中使用應用程式](https://docs.aws.amazon.com/codedeploy/latest/userguide/applications.html)。

對應的 UI：組態索引標籤/**CodeDeploy 應用程式**

## codedeploy-deployment-group
<a name="deploy.action.ecs.codedeploy.deploymentgroup"></a>

(*ECSDeployAction*/Configuration/**codedeploy-deployment-group**)

（如果`codedeploy-appspec`包含 則為必要）

指定現有 CodeDeploy 部署群組的名稱。如需 CodeDeploy 部署群組的詳細資訊，請參閱*AWS CodeDeploy 《 使用者指南*[》中的在 CodeDeploy 中使用部署群組](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-groups.html)。

對應的 UI：組態索引標籤/**CodeDeploy 部署群組**

## codedeploy-deployment-description
<a name="deploy.action.ecs.codedeploy.deploymentdescription"></a>

(*ECSDeployAction*/Configuration/**codedeploy-deployment-description**)

(選用)

指定此動作將建立之部署的描述。如需詳細資訊，請參閱*AWS CodeDeploy 《 使用者指南*》中的[在 CodeDeploy 中使用部署](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployments.html)。

對應的 UI：組態索引標籤/**CodeDeploy 部署描述**

# 使用工作流程部署至 Amazon EKS
<a name="deploy-action-eks"></a>

**提示**  
如需說明如何使用**部署至 Kubernetes 叢集**動作的教學課程，請參閱 [教學課程：將應用程式部署至 Amazon EKS](deploy-tut-eks.md)。

本節說明如何使用 CodeCatalyst 工作流程將容器化應用程式部署至 Kubernetes 叢集。若要達成此目的，您必須將**部署至 Kubernetes 叢集**動作新增至工作流程。此動作會將您的應用程式部署到您在 Amazon Elastic Kubernetes Service (EKS) 中使用一或多個 Kubernetes 資訊清單檔案設定的 Kubernetes 叢集。如需範例資訊清單，請參閱 [deployment.yaml](deploy-tut-eks.md#deploy-tut-eks-source-files-deployment-yml)中的 [教學課程：將應用程式部署至 Amazon EKS](deploy-tut-eks.md)。

如需 Kubernetes 的詳細資訊，請參閱 [Kubernetes 文件](https://kubernetes.io/docs/home/)。

如需 Amazon EKS 的詳細資訊，請參閱[什麼是 Amazon EKS？](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html) *Amazon EKS 使用者指南*中的 。

**Topics**
+ [「部署到 Kubernetes 叢集」動作的運作方式](#deploy-action-eks-howitworks)
+ [「部署至 Amazon EKS」動作所使用的執行期映像](#deploy-action-eks-runtime)
+ [教學課程：將應用程式部署至 Amazon EKS](deploy-tut-eks.md)
+ [將 'Deploy 新增至 Kubernetes 叢集' 動作](deploy-action-eks-adding.md)
+ [「部署到 Kubernetes 叢集」變數](deploy-action-eks-variables.md)
+ [「部署到 Kubernetes 叢集」動作 YAML](deploy-action-ref-eks.md)

## 「部署到 Kubernetes 叢集」動作的運作方式
<a name="deploy-action-eks-howitworks"></a>

**部署至 Kubernetes 叢集**的運作方式如下：

1. 在執行時間，動作會將 Kubernetes `kubectl`公用程式安裝到執行動作的 CodeCatalyst 運算機器。動作會將 設定為`kubectl`指向您在設定動作時提供的 Amazon EKS 叢集。接下來，需要 `kubectl`公用程式才能執行 `kubectl apply`命令。

1. 動作會執行 `kubectl apply -f my-manifest.yaml`命令，執行 *my-manifest.yaml* 中的指示，將您的應用程式部署為一組容器和 Pod 到設定的叢集。如需此命令的詳細資訊，請參閱 *Kubernetes 參考文件中*的 [kubectl 套用](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#apply)主題。

## 「部署至 Amazon EKS」動作所使用的執行期映像
<a name="deploy-action-eks-runtime"></a>

**部署至 Amazon EKS** 動作會在 [2022 年 11 月的映像](build-images.md#build.previous-image)上執行。如需詳細資訊，請參閱[作用中映像](build-images.md#build-curated-images)。

# 教學課程：將應用程式部署至 Amazon EKS
<a name="deploy-tut-eks"></a>

在本教學課程中，您將了解如何使用 Amazon CodeCatalyst 工作流程、Amazon EKS 和其他一些 AWS 服務，將容器化應用程式部署至 Amazon Elastic Kubernetes Service。部署的應用程式是簡單的「Hello， World！」 在 Apache Web 伺服器 Docker 映像上建置的網站。本教學課程會逐步解說必要的準備工作，例如設定開發機器和 Amazon EKS 叢集，然後說明如何建立工作流程來建置應用程式並將其部署到叢集。

初始部署完成後，教學會指示您變更應用程式來源。此變更會導致建立新的 Docker 映像，並使用新的修訂資訊推送到您的 Docker 映像儲存庫。然後，Docker 映像的新修訂會部署到 Amazon EKS。

**提示**  
您可以使用藍圖，為您完成 Amazon EKS 設定，而不是完成本教學課程。您需要使用 **EKS 應用程式部署**藍圖。如需詳細資訊，請參閱[使用藍圖建立專案](projects-create.md#projects-create-console-template)。

**Topics**
+ [先決條件](#deploy-tut-eks-prereqs)
+ [步驟 1：設定您的開發機器](#deploy-tut-eks-dev-env-create)
+ [步驟 2：建立 Amazon EKS 叢集](#deploy-tut-eks-cluster)
+ [步驟 3：建立 Amazon ECR 映像儲存庫](#deploy-tut-eks-ecr)
+ [步驟 4：新增來源檔案](#deploy-tut-eks-source-files)
+ [步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)
+ [步驟 6：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-eks-import-roles)
+ [步驟 7：更新 ConfigMap](#deploy-tut-eks-configmap)
+ [步驟 8：建立和執行工作流程](#deploy-tut-eks-workflow)
+ [步驟 9：變更來源檔案](#deploy-tut-eks-change)
+ [清除](#deploy-tut-eks-cleanup)

## 先決條件
<a name="deploy-tut-eks-prereqs"></a>

開始本教學課程之前：
+ 您需要具有連線 AWS 帳戶的 Amazon CodeCatalyst **空間**。如需詳細資訊，請參閱[建立空間](spaces-create.md)。
+ 在您的空間中，您需要一個名為 的空專案：

  ```
  codecatalyst-eks-project
  ```

  使用**從頭開始**選項來建立此專案。

  如需詳細資訊，請參閱[在 Amazon CodeCatalyst 中建立空專案](projects-create.md#projects-create-empty)。
+ 在您的專案中，您需要名為 的空 CodeCatalyst **來源儲存庫**：

  ```
  codecatalyst-eks-source-repository
  ```

  如需詳細資訊，請參閱[將程式碼與 CodeCatalyst 中的來源儲存庫一起存放和協作儲存程式碼並與來源儲存庫協作](source.md)。
+ 在專案中，您需要名為 的 CodeCatalyst CI/CD **環境** （而非開發環境）：

  ```
  codecatalyst-eks-environment
  ```

  設定此環境，如下所示：
  + 選擇任何類型的，例如**非生產**。
  + 將您的帳戶連接到該 AWS 帳戶。
  + 針對**預設 IAM 角色**，選擇任何角色。稍後您將指定不同的角色。

  如需詳細資訊，請參閱[部署至 AWS 帳戶 和 VPCs](deploy-environments.md)。

## 步驟 1：設定您的開發機器
<a name="deploy-tut-eks-dev-env-create"></a>

本教學課程的第一步是使用您將在本教學課程中使用的幾個工具來設定開發機器。這些工具包括：
+ `eksctl` 公用程式 – 用於建立叢集
+ `kubectl` 公用程式 – 的先決條件 `eksctl`
+  AWS CLI - 也是 的先決條件 `eksctl`

如果您有這些工具，則可以在現有的開發機器上安裝這些工具，也可以使用以雲端為基礎的 CodeCatalyst 開發環境。CodeCatalyst 開發環境的優點是，可輕鬆啟動和關閉，並與其他 CodeCatalyst 服務整合，可讓您以較少的步驟完成本教學課程。

本教學假設您將使用 CodeCatalyst 開發環境。

下列指示說明啟動 CodeCatalyst 開發環境並使用必要工具進行設定的快速方法，但如果您需要詳細說明，請參閱：
+ 本指南中的 [建立開發環境](devenvironment-create.md)。
+ 《**Amazon EKS 使用者指南**》中的[安裝 kubectl](https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html)。
+ 《**Amazon EKS 使用者指南**》中的[安裝或升級 eksctl](https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html)。
+ *AWS Command Line Interface 《 使用者指南*》中的[安裝或更新最新版本的 AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)。

**啟動開發環境**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 導覽至您的專案 `codecatalyst-eks-project`。

1. 在導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**。

1. 選擇來源儲存庫的名稱 `codecatalyst-eks-source-repository`。

1. 在最上方選擇**建立開發環境**，然後選擇 **AWS Cloud9 （在瀏覽器中）**。

1. 確定已選取**現有分支和主要分支中的工作**，然後選擇**建立**。 ****

   您的開發環境會在新的瀏覽器索引標籤中啟動，並將您的儲存庫 (`codecatalyst-eks-source-repository`) 複製到其中。

**安裝和設定 kubectl**

1. 在開發環境終端機中，輸入：

   ```
   curl -o kubectl https://amazon-eks.s3.us-west-2.amazonaws.com/1.18.9/2020-11-02/bin/linux/amd64/kubectl
   ```

1. 輸入：

   ```
   chmod +x ./kubectl
   ```

1. 輸入：

   ```
   mkdir -p $HOME/bin && cp ./kubectl $HOME/bin/kubectl && export PATH=$PATH:$HOME/bin
   ```

1. 輸入：

   ```
   echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc
   ```

1. 輸入：

   ```
   kubectl version --short --client
   ```

1. 檢查版本是否出現。

   您現在已安裝 `kubectl`。

**安裝和設定 eksctl**
**注意**  
`eksctl` 並非嚴格要求，因為您可以`kubectl`改為使用 。不過， `eksctl` 具有將大部分叢集組態自動化的好處，因此是本教學課程建議的工具。

1. 在開發環境終端機中，輸入：

   ```
   curl --silent --location "https://github.com/weaveworks/eksctl/releases/latest/download/eksctl_$(uname -s)_amd64.tar.gz" | tar xz -C /tmp
   ```

1. 輸入：

   ```
   sudo cp /tmp/eksctl /usr/bin
   ```

1. 輸入：

   ```
   eksctl version
   ```

1. 檢查版本是否出現。

   您現在已安裝 `eksctl`。

**驗證 AWS CLI 是否已安裝**

1. 在開發環境終端機中，輸入：

   ```
   aws --version
   ```

1. 檢查版本是否出現，以確認 AWS CLI 已安裝 。

   完成其餘程序， AWS CLI 以使用存取所需的許可來設定 AWS。

**若要設定 AWS CLI**

您必須 AWS CLI 使用存取金鑰和工作階段字符來設定 ，讓它存取 AWS 服務。下列指示提供設定金鑰和字符的快速方法，但如果您想要詳細說明，請參閱*AWS Command Line Interface 《 使用者指南*》中的[設定 AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) 。

1. 建立 IAM Identity Center 使用者，如下所示：

   1. 登入 AWS 管理主控台 ，並在 https：//[https://console.aws.amazon.com/singlesignon/](https://console.aws.amazon.com/singlesignon/) 開啟 AWS IAM Identity Center 主控台。

      （如果您從未登入 IAM Identity Center，您可能需要選擇**啟用**。)
**注意**  
請務必使用連線至 CodeCatalyst 空間 AWS 帳戶 的 登入。您可以透過導覽至您的空間並選擇 **AWS 帳戶索引標籤來驗證哪個帳戶**已連線。如需詳細資訊，請參閱[建立空間](spaces-create.md)。

   1. 在導覽窗格中，選擇 **使用者**，然後選擇 **新增使用者**。

   1. 在**使用者名稱**中，輸入：

      ```
      codecatalyst-eks-user
      ```

   1. 在**密碼**下，選擇**產生您可以與此使用者共用的一次性密碼**。

   1. 在**電子郵件地址**和**確認電子郵件地址**中，輸入 IAM Identity Center 中尚不存在的電子郵件地址。

   1. 在**名字**中，輸入：

      ```
      codecatalyst-eks-user
      ```

   1. 在**姓氏**中，輸入：

      ```
      codecatalyst-eks-user
      ```

   1. 在**顯示名稱**中，保留：

      ```
      codecatalyst-eks-user codecatalyst-eks-user
      ```

   1. 選擇**下一步**。

   1. 在**新增使用者至群組**頁面上，選擇**下一步**。

   1. 在**檢閱和新增使用者**頁面上，檢閱資訊，然後選擇**新增使用者**。

      **一次性密碼**對話方塊隨即出現。

   1. 選擇**複製**，然後將登入資訊貼到文字檔案。登入資訊包含 AWS 存取入口網站 URL、使用者名稱和一次性密碼。

   1. 選擇**關閉**。

1. 建立許可集，如下所示：

   1. 在導覽窗格中，選擇**許可集**，然後選擇**建立許可集**。

   1. 選擇**預先定義的許可集**，然後選取 **AdministratorAccess**。此政策提供所有 的完整許可 AWS 服務。

   1. 選擇**下一步**。

   1. 在**許可集名稱**中，移除`AdministratorAccess`並輸入：

      ```
      codecatalyst-eks-permission-set
      ```

   1. 選擇**下一步**。

   1. 在**檢閱和建立**頁面上，檢閱資訊，然後選擇**建立**。

1. 將許可集指派給 `codecatalyst-eks-user`，如下所示：

   1. 在導覽窗格中，選擇 **AWS 帳戶**，然後選取 AWS 帳戶 您目前登入之 旁的核取方塊。

   1. 選擇**指派使用者或群組**。

   1. 選擇**使用者**索引標籤。

   1. 選取 旁的核取方塊`codecatalyst-eks-user`。

   1. 選擇**下一步**。

   1. 選取 旁的核取方塊`codecatalyst-eks-permission-set`。

   1. 選擇**下一步**。

   1. 檢閱資訊，然後選擇**提交**。

      您現在已將 `codecatalyst-eks-user`和 `codecatalyst-eks-permission-set` 指派給 AWS 帳戶，並將它們繫結在一起。

1. 取得 `codecatalyst-eks-user`的存取金鑰和工作階段字符，如下所示：

   1. 請確定您擁有 AWS 存取入口網站 URL 以及 的使用者名稱和一次性密碼`codecatalyst-eks-user`。您應該稍早已將此資訊複製到文字編輯器。
**注意**  
如果您沒有此資訊，請前往 IAM Identity Center 的詳細資訊`codecatalyst-eks-user`頁面，選擇**重設密碼**、**產生一次性密碼 【...】** 和再次**重設密碼**，以在畫面上顯示資訊。

   1. 登出 AWS。

   1. 將 AWS 存取入口網站 URL 貼到瀏覽器的地址列。

   1. 使用 登入：
      + **使用者名稱**：

        ```
        codecatalyst-eks-user
        ```
      + **密碼**：

        *one-time-password*

   1. 在**設定新密碼**中，輸入新密碼，然後選擇**設定新密碼**。

      畫面上會出現一個**AWS 帳戶**方塊。

   1. 選擇 **AWS 帳戶**，然後選擇 AWS 帳戶 您指派`codecatalyst-eks-user`使用者和許可集的 名稱。

   1. 在 旁`codecatalyst-eks-permission-set`，選擇**命令列或程式設計存取**。

   1. 在頁面中間複製命令。它們看起來類似以下內容：

      ```
      export AWS_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE" 
      export AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" 
      export AWS_SESSION_TOKEN="session-token"
      ```

      ...其中 *session-token* 是長隨機字串。

1. 將存取金鑰和工作階段字符新增至 AWS CLI，如下所示：

   1. 返回 CodeCatalyst 開發環境。

   1. 在終端機提示中，貼上您複製的命令。按 Enter。

      您現在已 AWS CLI 使用存取金鑰和工作階段字符設定 。您現在可以使用 AWS CLI 完成本教學課程所需的任務。
**重要**  
如果您在本教學課程中的任何時候看到類似如下的訊息：  
`Unable to locate credentials. You can configure credentials by running "aws configure".`  
或者：  
`ExpiredToken: The security token included in the request is expired`  
...這是因為您的 AWS CLI 工作階段已過期。在此情況下，*請勿*執行 `aws configure`命令。請改用此程序步驟 4 中以 開頭的指示`Obtain codecatalyst-eks-user's access key and session token`來重新整理工作階段。

## 步驟 2：建立 Amazon EKS 叢集
<a name="deploy-tut-eks-cluster"></a>

在本節中，您會在 Amazon EKS 中建立叢集。以下指示說明使用 建立叢集的快速方法`eksctl`，但如果您想要詳細說明，請參閱：
+ 《**Amazon EKS 使用者指南**》中的 [eksctl 入門](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html) 

  或
+ [主控台入門和《Amazon EKS 使用者指南 AWS CLI](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-console.html)****》中的 （本主題提供建立叢集`kubectl`的說明） 

**注意**  
CodeCatalyst 與 Amazon EKS 整合不支援[私有叢集](https://docs.aws.amazon.com/eks/latest/userguide/private-clusters.html)。

**開始之前**

請確定您已在開發機器上完成下列任務：
+ 安裝 `eksctl`公用程式。
+ 已安裝 `kubectl`公用程式。
+ 安裝 並使用存取金鑰 AWS CLI 和工作階段字符進行設定。

如需如何完成這些任務的資訊，請參閱 [步驟 1：設定您的開發機器](#deploy-tut-eks-dev-env-create)。

**建立叢集**
**重要**  
請勿使用 Amazon EKS 服務的使用者介面來建立叢集，因為叢集無法正確設定。使用 `eksctl`公用程式，如下列步驟所述。

1. 前往您的開發環境。

1. 建立叢集和節點：

   ```
   eksctl create cluster --name codecatalyst-eks-cluster --region us-west-2
   ```

   其中：
   + *codecatalyst-eks-cluster* 會取代為您要提供叢集的名稱。
   + *us-west-2* 已取代為您的 區域。

   10-20 分鐘後，會出現類似以下內容的訊息：

   `EKS cluster "codecatalyst-eks-cluster" in "us-west-2" region is ready`
**注意**  
建立叢集時 AWS ，您會看到多個`waiting for CloudFormation stack`訊息。這是預期的行為。

1. 確認您的叢集已成功建立：

   ```
   kubectl cluster-info
   ```

   您將看到類似以下的訊息，指出成功的叢集建立：

   ```
   Kubernetes master is running at https://long-string.gr7.us-west-2.eks.amazonaws.com
   CoreDNS is running at https://long-string.gr7.us-west-2.eks.amazonaws.com/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy
   ```

## 步驟 3：建立 Amazon ECR 映像儲存庫
<a name="deploy-tut-eks-ecr"></a>

在本節中，您會在 Amazon Elastic Container Registry (Amazon ECR) 中建立私有映像儲存庫。此儲存庫會存放教學課程的 Docker 映像。

如需 Amazon ECR 的詳細資訊，請參閱《*Amazon Elastic Container Registry 使用者指南*》。

**在 Amazon ECR 中建立映像儲存庫**

1. 前往您的開發環境。

1. 在 Amazon ECR 中建立空儲存庫：

   ```
   aws ecr create-repository --repository-name codecatalyst-eks-image-repo
   ```

   將 *codecatalyst-eks-image-repo* 取代為您要提供 Amazon ECR 儲存庫的名稱。

   本教學假設您已將儲存庫命名為 `codecatalyst-eks-image-repo`。

1. 顯示 Amazon ECR 儲存庫的詳細資訊：

   ```
   aws ecr describe-repositories \
         --repository-names codecatalyst-eks-image-repo
   ```

1. 請記下 `“repositoryUri”:`值，例如 `111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-eks-image-repo`。

   稍後在將儲存庫新增至工作流程時需要它。

## 步驟 4：新增來源檔案
<a name="deploy-tut-eks-source-files"></a>

在本節中，您將應用程式來源檔案新增至來源儲存庫 (`codecatalyst-eks-source-repository`)。它們包含：
+ `index.html` 檔案 – 顯示「Hello， World！」 瀏覽器中的 訊息。
+ Dockerfile – 描述要用於 Docker 映像的基本映像，以及要套用的 Docker 命令。
+ `deployment.yaml` 檔案 – 定義 Kubernetes 服務和部署的 Kubernetes 資訊清單。

資料夾結構如下所示：

```
|— codecatalyst-eks-source-repository
   |— Kubernetes
      |— deployment.yaml
   |— public-html
   |  |— index.html
   |— Dockerfile
```

**Topics**
+ [index.html](#deploy-tut-eks-source-files-index)
+ [Dockerfile](#deploy-tut-eks-source-files-dockerfile)
+ [deployment.yaml](#deploy-tut-eks-source-files-deployment-yml)

### index.html
<a name="deploy-tut-eks-source-files-index"></a>

`index.html` 檔案會顯示「Hello， World！」 瀏覽器中的 訊息。

**新增 index.html 檔案**

1. 前往您的開發環境。

1. 在 中`codecatalyst-eks-source-repository`，建立名為 的資料夾`public-html`。

1. 在 中`/public-html`，建立名為 的檔案`index.html`，其中包含下列內容：

   ```
   <html>
     <head>
       <title>Hello World</title>
       <style>
         body {
         background-color: black;
         text-align: center;
         color: white;
         font-family: Arial, Helvetica, sans-serif;
         }  
       </style>
     </head>
     <body>
       <h1>Hello, World!</h1>
     </body>
   </html>
   ```

1. 在終端機提示中，輸入：

   ```
   cd /projects/codecatalyst-eks-source-repository
   ```

1. 新增、遞交和推送：

   ```
   git add .
   git commit -m "add public-html/index.html"
   git push
   ```

   `index.html` 會新增至`public-html`資料夾中的儲存庫。

### Dockerfile
<a name="deploy-tut-eks-source-files-dockerfile"></a>

Dockerfile 說明要使用的基本 Docker 映像，以及要套用的 Docker 命令。如需 Dockerfile 的詳細資訊，請參閱 [Dockerfile 參考](https://docs.docker.com/engine/reference/builder/)。

此處指定的 Dockerfile 表示使用 Apache 2.4 基礎映像 (`httpd`)。它還包含將名為 的來源檔案複製到提供網頁之 Apache 伺服器上的`index.html`資料夾的說明。Dockerfile 中的`EXPOSE`說明會告知 Docker 容器正在接聽連接埠 80。

**新增 Dockerfile**

1. 在 中`codecatalyst-eks-source-repository`，建立名為 的檔案`Dockerfile`，其中包含下列內容：

   ```
   FROM httpd:2.4
   COPY ./public-html/index.html /usr/local/apache2/htdocs/index.html
   EXPOSE 80
   ```

   請勿包含副檔名。
**重要**  
Dockerfile 必須位於儲存庫的根資料夾中。工作流程的 `Docker build`命令預期會存在。

1. 新增、遞交和推送：

   ```
   git add .
   git commit -m "add Dockerfile"
   git push
   ```

   Dockerfile 會新增至您的儲存庫。

### deployment.yaml
<a name="deploy-tut-eks-source-files-deployment-yml"></a>

在本節中，您將`deployment.yaml`檔案新增至您的儲存庫。`deployment.yaml` 檔案是 Kubernetes 資訊清單，定義兩個**要執行的 Kubernetes 資源類型：「服務和「部署」。
+ 「服務」會將負載平衡器部署到 Amazon EC2。負載平衡器為您提供面向網際網路的公有 URL 和標準連接埠 （連接埠 80)，可用來瀏覽至 'Hello， World！' 應用程式。
+ 「部署」會部署三個 Pod，每個 Pod 都會包含 Docker 容器，其中包含「Hello， World！」 應用程式。這三個 Pod 會部署到您建立叢集時建立的節點上。

本教學課程中的資訊清單很簡短；不過，資訊清單可以包含任意數量的 Kubernetes 資源類型，例如 Pod、任務、輸入和網路政策。此外，如果您的部署很複雜，您可以使用多個資訊清單檔案。

**新增 deployment.yaml 檔案**

1. 在 中`codecatalyst-eks-source-repository`，建立名為 的資料夾`Kubernetes`。

1. 在 中`/Kubernetes`，建立名為 的檔案`deployment.yaml`，其中包含下列內容：

   ```
   apiVersion: v1
   kind: Service
   metadata:
     name: my-service
     labels:
       app: my-app
   spec:
     type: LoadBalancer
     selector:
       app: my-app
     ports:
       - protocol: TCP
         port: 80
         targetPort: 80
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
     labels:
       app: my-app
   spec:
     replicas: 3
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
       spec:
         containers:
         - name: codecatalyst-eks-container
           # The $REPOSITORY_URI and $IMAGE_TAG placeholders will be replaced by actual values supplied by the build action in your workflow
           image: $REPOSITORY_URI:$IMAGE_TAG
           ports:
           - containerPort: 80
   ```

1. 新增、遞交和推送：

   ```
   git add .
   git commit -m "add Kubernetes/deployment.yaml"
   git push
   ```

   `deployment.yaml` 檔案會新增至名為 的資料夾中的儲存庫`Kubernetes`。

您現在已新增所有來源檔案。

花一點時間仔細檢查您的工作，並確保將所有檔案放在正確的資料夾中。資料夾結構如下所示：

```
|— codecatalyst-eks-source-repository
   |— Kubernetes
      |— deployment.yaml
   |— public-html
   |  |— index.html
   |— Dockerfile
```

## 步驟 5：建立 AWS 角色
<a name="deploy-tut-eks-roles"></a>

在本節中，您會建立 CodeCatalyst AWS 工作流程運作所需的 IAM 角色。這些角色包括：
+ **組建角色** – 授予 CodeCatalyst 組建動作 （在工作流程中） 存取 AWS 您的帳戶和寫入 Amazon ECR 和 Amazon EC2 的許可。
+ **部署角色** – 授予 CodeCatalyst **部署到 Kubernetes 叢集**動作 （在工作流程中） 存取 AWS 您的帳戶和 Amazon EKS 的許可。

如需 IAM 角色的詳細資訊，請參閱*AWS Identity and Access Management 《 使用者指南*》中的 [IAM 角色](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)。

**注意**  
若要節省時間，您可以建立稱為角色的單一`CodeCatalystWorkflowDevelopmentRole-spaceName`角色，而不是先前列出的兩個角色。如需詳細資訊，請參閱[為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有非常廣泛的許可，這可能會構成安全風險。我們建議您只在安全性較少的教學課程和案例中使用此角色。本教學假設您正在建立先前列出的兩個角色。

若要建立建置和部署角色，請完成下列一系列程序。

**1. 為兩個角色建立信任政策**

1. 前往您的開發環境。

1. 在 `Cloud9-long-string`目錄中，建立名為 的檔案`codecatalyst-eks-trust-policy.json`，其中包含下列內容：

**2. 建立建置角色的建置政策**
+ 在 `Cloud9-long-string`目錄中，建立名為 的檔案`codecatalyst-eks-build-policy.json`，其中包含下列內容：

------
#### [ JSON ]

****  

  ```
  {
      "Version":"2012-10-17",		 	 	 
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "ecr:*",
                  "ec2:*"
              ],
              "Resource": "*"
          }
      ]
  }
  ```

------
**注意**  
第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元，然後在資源名稱可用之後縮小政策的範圍。  

  ```
  "Resource": "*"
  ```

**3. 建立部署角色的部署政策**
+ 在 `Cloud9-long-string`目錄中，建立名為 的檔案`codecatalyst-eks-deploy-policy.json`，其中包含下列內容：

------
#### [ JSON ]

****  

  ```
  {
      "Version":"2012-10-17",		 	 	 
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "eks:DescribeCluster",
                  "eks:ListClusters"
              ],
              "Resource": "*"
          }
      ]
  }
  ```

------
**注意**  
第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元，然後在資源名稱可用之後縮小政策的範圍。  

  ```
  "Resource": "*"
  ```

您現在已將三個政策文件新增至開發環境。您的目錄結構現在如下所示：

```
|— Cloud9-long-string
   |— .c9
   |— codecatalyst-eks-source-repository
      |— Kubernetes
      |— public-html
      |— Dockerfile
   codecatalyst-eks-build-policy.json
   codecatalyst-eks-deploy-policy.json
   codecatalyst-eks-trust-policy.json
```

**4. 將建置政策新增至 AWS**

1. 在開發環境終端機中，輸入：

   ```
   cd /projects
   ```

1. 輸入：

   ```
   aws iam create-policy \
       --policy-name codecatalyst-eks-build-policy \
       --policy-document file://codecatalyst-eks-build-policy.json
   ```

1. 按 **Enter**。

1. 在命令輸出中，記下 `"arn":`值，例如 `arn:aws:iam::111122223333:policy/codecatalyst-eks-build-policy`。您稍後需要此 ARN。

**5. 將部署政策新增至 AWS**

1. 輸入：

   ```
   aws iam create-policy \
       --policy-name codecatalyst-eks-deploy-policy \
       --policy-document file://codecatalyst-eks-deploy-policy.json
   ```

1. 按 **Enter**。

1. 在命令輸出中，記下部署政策`"arn":`的值，例如 `arn:aws:iam::111122223333:policy/codecatalyst-eks-deploy-policy`。您稍後需要此 ARN。

**6. 建立建置角色**

1. 輸入：

   ```
   aws iam create-role \
         --role-name codecatalyst-eks-build-role \
         --assume-role-policy-document file://codecatalyst-eks-trust-policy.json
   ```

1. 按 **Enter**。

1. 輸入：

   ```
   aws iam attach-role-policy \
         --role-name codecatalyst-eks-build-role \
         --policy-arn arn:aws:iam::111122223333:policy/codecatalyst-eks-build-policy
   ```

   其中 *arn：aws：iam：：111122223333：policy/codecatalyst-eks-build-policy* 會取代為您先前記下的建置政策的 ARN。

1. 按 **Enter**。

1. 在終端機提示中，輸入：

   ```
   aws iam get-role \
         --role-name codecatalyst-eks-build-role
   ```

1. 按 **Enter**。

1. 請記下角色`"Arn":`的值，例如 `arn:aws:iam::111122223333:role/codecatalyst-eks-build-role`。您稍後需要此 ARN。

**7. 建立部署角色**

1. 輸入：

   ```
   aws iam create-role \
         --role-name codecatalyst-eks-deploy-role \
         --assume-role-policy-document file://codecatalyst-eks-trust-policy.json
   ```

1. 按 **Enter**。

1. 輸入：

   ```
   aws iam attach-role-policy \
         --role-name codecatalyst-eks-deploy-role \
         --policy-arn arn:aws:iam::111122223333:policy/codecatalyst-eks-deploy-policy
   ```

   其中 *arn：aws：iam：：111122223333：policy/codecatalyst-eks-deploy-policy* 會取代為您先前記下的部署政策的 ARN。

1. 按 **Enter**。

1. 輸入：

   ```
   aws iam get-role \
         --role-name codecatalyst-eks-deploy-role
   ```

1. 按 **Enter**。

1. 請記下角色`"Arn":`的值，例如 `arn:aws:iam::111122223333:role/codecatalyst-eks-deploy-role`。您稍後需要此 ARN。

您現在已建立建置和部署角色，並記下其 ARNs。

## 步驟 6：將 AWS 角色新增至 CodeCatalyst
<a name="deploy-tut-eks-import-roles"></a>

在此步驟中，您將建置角色 (`codecatalyst-eks-build-role`) 和部署角色 (`codecatalyst-eks-deploy-role`) 新增至您連線至空間 AWS 帳戶 的 。這可讓角色在您的工作流程中使用。

**將建置和部署角色新增至您的 AWS 帳戶**

1. 在 CodeCatalyst 主控台中，導覽至您的空間。

1. 在頂端，選擇**設定**。

1. 在導覽窗格中，選擇**AWS 帳戶**。帳戶清單隨即出現。

1. 在 **Amazon CodeCatalyst 顯示名稱**欄中，複製 AWS 帳戶 您建立建置和部署角色的 顯示名稱。（可能是數字。) 稍後建立工作流程時，您將需要此值。

1. 選擇顯示名稱。

1. **從管理主控台選擇 AWS 管理角色**。

   **將 IAM 角色新增至 Amazon CodeCatalyst 空間**頁面隨即出現。您可能需要登入才能存取頁面。

1. 選取**新增您在 IAM 中建立的現有角色**。

   下拉式清單隨即出現。清單會顯示建置和部署角色，以及具有包含 `codecatalyst-runner.amazonaws.com``codecatalyst.amazonaws.com`和服務主體之信任政策的任何其他 IAM 角色。

1. 從下拉式清單中，新增：
   + `codecatalyst-eks-build-role`
   + `codecatalyst-eks-deploy-role`
**注意**  
如果您看到 `The security token included in the request is invalid`，可能是因為您沒有適當的許可。若要修正此問題，請以您建立 CodeCatalyst 空間時使用 AWS 的帳戶登入 AWS 身分登出 。

1. 返回 CodeCatalyst 主控台並重新整理頁面。

   建置和部署角色現在應該會出現在 **IAM 角色**下。

   這些角色現在可用於 CodeCatalyst 工作流程。

## 步驟 7：更新 ConfigMap
<a name="deploy-tut-eks-configmap"></a>

您必須將您在 中建立的部署角色新增至 [步驟 5：建立 AWS 角色](#deploy-tut-eks-roles) Kubernetes `ConfigMap` 檔案，讓**部署至 Kubernetes 叢集**動作 （在您的工作流程中） 能夠存取叢集並與叢集互動。您可以使用 `eksctl`或 `kubectl` 來執行此任務。

**使用 eksctl 設定 Kubernetes ConfigMap 檔案**
+ 在開發環境終端機中，輸入：

  ```
  eksctl create iamidentitymapping --cluster codecatalyst-eks-cluster --arn arn:aws:iam::111122223333:role/codecatalyst-eks-deploy-role --group system:masters --username codecatalyst-eks-deploy-role --region us-west-2
  ```

  其中：
  + *codecatalyst-eks-cluster* 會取代為 Amazon EKS 叢集的叢集名稱。
  +  *arn：aws：iam：：111122223333：role/codecatalyst-eks-deploy-role* 會取代為您在 中建立之部署角色的 ARN[步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。
  +  *codecatalyst-eks-deploy-role* ( 旁`--username`) 會取代為您在 中建立的部署角色名稱[步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。
**注意**  
如果您決定不建立部署角色，請將 *codecatalyst-eks-deploy-role* 取代為`CodeCatalystWorkflowDevelopmentRole-spaceName`角色的名稱。如需有關此角色的詳細資訊，請參閱 [步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。
  +  *us-west-2* 已取代為您的 區域。

  如需此命令的詳細資訊，請參閱[管理 IAM 使用者和角色](https://eksctl.io/usage/iam-identity-mappings/)。

  出現類似下列的訊息：

  ```
  2023-06-09 00:58:29 [ℹ]  checking arn arn:aws:iam::111122223333:role/codecatalyst-eks-deploy-role against entries in the auth ConfigMap
  2023-06-09 00:58:29 [ℹ]  adding identity "arn:aws:iam::111122223333:role/codecatalyst-eks-deploy-role" to auth ConfigMap
  ```

**使用 kubectl 設定 Kubernetes ConfigMap 檔案**

1. 在開發環境終端機中，輸入：

   ```
   kubectl edit configmap -n kube-system aws-auth
   ```

   ConfigMap 檔案會顯示在畫面上。

1. 新增紅色斜體的文字：

   ```
   # Please edit the object below. Lines beginning with a '#' will be ignored,
   # and an empty file will abort the edit. If an error occurs while saving this file will be
   # reopened with the relevant failures.
   #
   apiVersion: v1
   data:
     mapRoles: |
       - groups:
         - system:bootstrappers
         - system:nodes
         rolearn: arn:aws:iam::111122223333:role/eksctl-codecatalyst-eks-cluster-n-NodeInstanceRole-16BC456ME6YR5
         username: system:node:{{EC2PrivateDNSName}}
       - groups:
         - system:masters
         rolearn: arn:aws:iam::111122223333:role/codecatalyst-eks-deploy-role
         username: codecatalyst-eks-deploy-role
     mapUsers: |
       []
   kind: ConfigMap
   metadata:
     creationTimestamp: "2023-06-08T19:04:39Z"
     managedFields:
     ...
   ```

   其中：
   +  *arn：aws：iam：：111122223333：role/codecatalyst-eks-deploy-role* 會取代為您在 中建立之部署角色的 ARN[步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。
   +  *codecatalyst-eks-deploy-role* ( 旁`username:`) 會取代為您在 中建立的部署角色名稱[步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。
**注意**  
如果您決定不建立部署角色，請將 *codecatalyst-eks-deploy-role* 取代為`CodeCatalystWorkflowDevelopmentRole-spaceName`角色的名稱。如需有關此角色的詳細資訊，請參閱 [步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。

   如需詳細資訊，請參閱《**Amazon** [EKS 使用者指南》中的啟用叢集的 IAM 主體存取權](https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html)。

您現在已提供部署角色，並透過擴充**部署至 Amazon EKS** 動作，將`system:masters`許可授予您的 Kubernetes 叢集。

## 步驟 8：建立和執行工作流程
<a name="deploy-tut-eks-workflow"></a>

在此步驟中，您會建立工作流程來取得來源檔案、將它們建置到 Docker 映像中，然後將映像部署到 Amazon EKS 叢集中的樹莢中。

工作流程包含下列依次執行的建置區塊：
+ 觸發條件 – 當您將變更推送至來源儲存庫時，此觸發條件會自動啟動工作流程執行。關於觸發條件的詳細資訊，請參閱 [使用觸發程序自動啟動工作流程執行](workflows-add-trigger.md)。
+ 建置動作 (`BuildBackend`) – 觸發時，動作會使用 Dockerfile 建置 Docker 映像，並將映像推送至 Amazon ECR。建置動作也會使用正確的值更新 `deployment.yaml` 檔案中的 `$REPOSITORY_URI`和 `$IMAGE_TAG`變數，然後建立此檔案和 `Kubernetes` 資料夾中任何其他檔案的輸出成品。在本教學課程中，`Kubernetes`資料夾中唯一的檔案是 ，`deployment.yaml`但您可以包含更多檔案。成品會用作部署動作的輸入，接下來是 。

  如需建置動作的詳細資訊，請參閱 [使用工作流程建置](build-workflow-actions.md)。
+ 部署動作 (`DeployToEKS`) – 完成建置動作時，部署動作會尋找建置動作 (`Manifests`) 產生的輸出成品，並在其中尋找`deployment.yaml`檔案。動作接著會依照 `deployment.yaml` 檔案中的指示執行三個 Pod，每個都包含單一 'Hello， World！' Docker 容器 - Amazon EKS 叢集內部。

**建立工作流程**

1. 前往 CodeCatalyst 主控台。

1. 導覽至您的專案 (`codecatalyst-eks-project`)。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇**建立工作流程**。

1. 針對**來源儲存庫**，選擇 `codecatalyst-eks-source-repository`。

1. 針對**分支**，選擇 `main`。

1. 選擇**建立**。

1. 刪除 YAML 範例程式碼。

1. 新增下列 YAML 程式碼以建立新的工作流程定義檔案：
**注意**  
如需工作流程定義檔案的詳細資訊，請參閱 [工作流程 YAML 定義](workflow-reference.md)。
**注意**  
在下列 YAML 程式碼中，您可以視需要省略這些`Connections:`區段。如果您省略這些區段，您必須確保環境中**預設 IAM 角色**欄位中指定的角色包含 中所述兩個角色的許可和信任政策[步驟 6：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-eks-import-roles)。如需使用預設 IAM 角色設定環境的詳細資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

   ```
   Name: codecatalyst-eks-workflow
   SchemaVersion: 1.0
   
   Triggers:
     - Type: PUSH
       Branches:
         - main
   Actions:
     BuildBackend:
       Identifier: aws/build@v1
       Environment:
         Name: codecatalyst-eks-environment
         Connections:
           - Name: codecatalyst-account-connection
             Role: codecatalyst-eks-build-role
       Inputs:
         Sources:
           - WorkflowSource
         Variables:
           - Name: REPOSITORY_URI
             Value: 111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-eks-image-repo
           - Name: IMAGE_TAG
             Value: ${WorkflowSource.CommitId}
       Configuration:
         Steps:
           #pre_build:
           - Run: echo Logging in to Amazon ECR...
           - Run: aws --version
           - Run: aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin 111122223333.dkr.ecr.us-west-2.amazonaws.com
           #build:
           - Run: echo Build started on `date`
           - Run: echo Building the Docker image...
           - Run: docker build -t $REPOSITORY_URI:latest .
           - Run: docker tag $REPOSITORY_URI:latest $REPOSITORY_URI:$IMAGE_TAG
           #post_build:
           - Run: echo Build completed on `date`
           - Run: echo Pushing the Docker images...
           - Run: docker push $REPOSITORY_URI:latest
           - Run: docker push $REPOSITORY_URI:$IMAGE_TAG
           # Replace the variables in deployment.yaml
           - Run: find Kubernetes/ -type f | xargs sed -i "s|\$REPOSITORY_URI|$REPOSITORY_URI|g"
           - Run: find Kubernetes/ -type f | xargs sed -i "s|\$IMAGE_TAG|$IMAGE_TAG|g"
           - Run: cat Kubernetes/*
           # The output artifact will be a zip file that contains Kubernetes manifest files.
       Outputs:
         Artifacts:
           - Name: Manifests
             Files: 
               - "Kubernetes/*"
     DeployToEKS:
       DependsOn: 
         - BuildBackend
       Identifier: aws/kubernetes-deploy@v1
       Environment:
         Name: codecatalyst-eks-environment
         Connections:
           - Name: codecatalyst-account-connection
             Role: codecatalyst-eks-deploy-role
       Inputs:
         Artifacts:
           - Manifests
       Configuration:
         Namespace: default
         Region: us-west-2
         Cluster: codecatalyst-eks-cluster
         Manifests: Kubernetes/
   ```

   在上述程式碼中，取代：
   + 兩個 *codecatalyst-eks-environment* 執行個體，其名稱為您在 中建立的環境[先決條件](#deploy-tut-eks-prereqs)。
   + 這兩個 *codecatalyst-account-connection* 執行個體都具有您帳戶連線的顯示名稱。顯示名稱可能是數字。如需詳細資訊，請參閱[步驟 6：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-eks-import-roles)。
   + *codecatalyst-eks-build-role*，其中包含您在 中建立的建置角色名稱[步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。
   + *111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-eks-image-repo* （在 `Value:` 屬性中），其中包含您在 中建立的 Amazon ECR 儲存庫的 URI[步驟 3：建立 Amazon ECR 映像儲存庫](#deploy-tut-eks-ecr)。
   + *111122223333.dkr.ecr.us-west-2.amazonaws.com* （在 `Run: aws ecr`命令中），不含映像尾碼 () 的 Amazon ECR 儲存庫的 URI`/codecatalyst-eks-image-repo`。
   + *codecatalyst-eks-deploy-role*，內含您在 中建立的部署角色名稱[步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。
   + 使用 AWS 區域碼的 *us-west-2* 這兩個執行個體。如需區域代碼清單，請參閱《》中的[區域端點](https://docs.aws.amazon.com/general/latest/gr/rande.html)*AWS 一般參考*。
**注意**  
如果您決定不建立建置和部署角色，請將 *codecatalyst-eks-build-role* 和 *codecatalyst-eks-deploy-role* 取代為`CodeCatalystWorkflowDevelopmentRole-spaceName`角色的名稱。如需有關此角色的詳細資訊，請參閱 [步驟 5：建立 AWS 角色](#deploy-tut-eks-roles)。

1. （選用） 選擇**驗證**，以確保 YAML 程式碼在遞交之前有效。

1. 選擇 **Commit** (遞交)。

1. 在**遞交工作流程**對話方塊中，輸入下列內容：

   1. 針對**遞交訊息**，移除文字並輸入：

      ```
      Add first workflow
      ```

   1. 針對**儲存庫**，選擇 `codecatalyst-eks-source-repository`。

   1. 針對**分支名稱**，選擇主要。

   1. 選擇 **Commit** (遞交)。

   您現在已建立工作流程。由於工作流程頂端定義的觸發條件，工作流程執行會自動啟動。具體而言，當您將`workflow.yaml`檔案遞交 （並推送） 至來源儲存庫時，觸發會啟動工作流程執行。

**檢視工作流程執行進度**

1. 在 CodeCatalyst 主控台的導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇您剛建立的工作流程 `codecatalyst-eks-workflow`。

1. 選擇 **BuildBackend** 以查看建置進度。

1. 選擇 **DeployToEKS** 以查看部署進度。

   如需檢視執行詳細資訊的詳細資訊，請參閱 [檢視工作流程執行狀態和詳細資訊](workflows-view-run.md)。

**驗證部署**

1. 前往 [https://console.aws.amazon.com/ec2/](https://console.aws.amazon.com/ec2/) 開啟 Amazon EC2 主控台。

1. 在左側底部附近，選擇**負載平衡器**。

1. 選取在 Kubernetes 部署中建立的負載平衡器。如果您不確定要選擇哪個負載平衡器，請在標籤索引標籤下尋找下列**標籤**：
   + `kubernetes.io/service-name`
   + `kubernetes.io/cluster/ekstutorialcluster`

1. 選取正確的負載平衡器後，選擇**描述**索引標籤。

1. 將 **DNS 名稱**值複製並貼到瀏覽器的地址列。

   'Hello， World！' 網頁會顯示在瀏覽器中，表示您已成功部署應用程式。

## 步驟 9：變更來源檔案
<a name="deploy-tut-eks-change"></a>

在本節中，您會變更來源儲存庫中的 `index.html` 檔案。此變更會導致工作流程建立新的 Docker 映像、使用遞交 ID 標記它、將其推送至 Amazon ECR，並將其部署至 Amazon ECS。

**若要變更 index.html**

1. 前往您的開發環境。

1. 在終端機提示中，變更至您的來源儲存庫：

   ```
   cd /projects/codecatalyst-eks-source-repository
   ```

1.  提取最新的工作流程變更：

   ```
   git pull
   ```

1. 打開 `codecatalyst-eks-source-repository/public-html/index.html`。

1. 在第 14 行，將`Hello, World!`文字變更為 `Tutorial complete!`。

1. 新增、遞交和推送：

   ```
   git add .
   git commit -m "update index.html title"
   git push
   ```

   工作流程執行會自動啟動。

1. （選用） 輸入：

   ```
   git show HEAD
   ```

   請注意`index.html`變更的遞交 ID。此遞交 ID 將標記到 Docker 映像，該映像將由您剛啟動的工作流程執行所部署。

1. 觀看部署進度：

   1. 在 CodeCatalyst 主控台的導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

   1. 選擇 `codecatalyst-eks-workflow`以檢視最新的執行。

   1. 選擇 **BuildBackend** 和 **DeployToEKS** 以查看工作流程執行進度。

1. 確認您的應用程式已更新，如下所示：

   1. 前往 [https://console.aws.amazon.com/ec2/](https://console.aws.amazon.com/ec2/) 開啟 Amazon EC2 主控台。

   1. 在左側底部附近，選擇**負載平衡器**。

   1. 選取在 Kubernetes 部署中建立的負載平衡器。

   1. 將 **DNS 名稱**值複製並貼到瀏覽器的地址列。

      「教學完成！」 網頁會顯示在瀏覽器中，表示您已成功部署應用程式的新修訂版。

1. （選用） 在 中 AWS，切換到 Amazon ECR 主控台，並確認新的 Docker 映像已標記此程序步驟 7 的遞交 ID。

## 清除
<a name="deploy-tut-eks-cleanup"></a>

您應該清除您的環境，以免不必要地向您收取本教學課程使用的儲存和運算資源的費用。

**清理方式**

1. 刪除您的叢集：

   1. 在開發環境終端機中，輸入：

     ```
     eksctl delete cluster --region=us-west-2 --name=codecatalyst-eks-cluster
     ```

     其中：
     + *us-west-2* 已取代為您的 區域。
     + *codecatalyst-eks-cluster* 會取代為您建立的叢集名稱。

     5-10 分鐘後，會刪除叢集和相關聯的資源，包括但不限於 CloudFormation 堆疊、節點群組 （在 Amazon EC2 中） 和負載平衡器。
**重要**  
如果`eksctl delete cluster`命令無法運作，您可能需要重新整理登入 AWS 資料或登入`kubectl`資料。如果您不確定要重新整理哪些登入資料，請先重新整理 AWS 登入資料。若要重新整理您的 AWS 登入資料，請參閱 [如何修正「找不到登入資料」和「ExpiredToken」錯誤？](troubleshooting-workflows.md#troubleshooting-workflows-auth-errors-eks)。若要重新整理您的`kubectl`登入資料，請參閱 [如何修正「無法連線至伺服器」錯誤？](troubleshooting-workflows.md#troubleshooting-workflows-unable-connect-eks)。

1. 在 AWS 主控台中，如下所示進行清除：

   1. 在 Amazon ECR 中，刪除 `codecatalyst-eks-image-repo`。

   1. 在 IAM Identity Center 中，刪除：

      1. `codecatalyst-eks-user`

      1. `codecatalyst-eks-permission-set`

   1. 在 IAM 中，刪除：
      + `codecatalyst-eks-build-role`
      + `codecatalyst-eks-deploy-role`
      + `codecatalyst-eks-build-policy`
      + `codecatalyst-eks-deploy-policy`

1. 在 CodeCatalyst 主控台中，如下所示進行清除：

   1. 刪除 `codecatalyst-eks-workflow`。

   1. 刪除 `codecatalyst-eks-environment`。

   1. 刪除 `codecatalyst-eks-source-repository`。

   1. 刪除您的開發環境。

   1. 刪除 `codecatalyst-eks-project`。

在本教學課程中，您已了解如何使用 CodeCatalyst 工作流程和部署至 **Kubernetes 叢集動作，將應用程式部署至 Amazon EKS **服務。

# 將 'Deploy 新增至 Kubernetes 叢集' 動作
<a name="deploy-action-eks-adding"></a>

使用下列指示將**部署至 Kubernetes 叢集**動作新增至您的工作流程。

**開始之前**

將**部署至 Kubernetes 叢集**動作新增至工作流程之前，您必須備妥下列項目：

**提示**  
若要快速設定這些先決條件，請遵循 中的指示[教學課程：將應用程式部署至 Amazon EKS](deploy-tut-eks.md)。
+ Amazon EKS 中的 Kubernetes 叢集。如需叢集的相關資訊，請參閱《[Amazon EKS 使用者指南》中的 Amazon EKS 叢集](https://docs.aws.amazon.com/eks/latest/userguide/clusters.html)。 ****
+ 至少一個 Dockerfile，說明如何將應用程式組合成 Docker 映像。如需 Dockerfiles 的詳細資訊，請參閱 [Dockerfile 參考](https://docs.docker.com/engine/reference/builder/)。
+ 至少一個 Kubernetes 資訊清單檔案，在 Kubernetes 文件中稱為*組態檔案*或*組態*。如需詳細資訊，請參閱 Kubernetes 文件中的[管理資源](https://kubernetes.io/docs/concepts/cluster-administration/manage-deployment/)。
+ IAM 角色，可讓**部署至 Kubernetes 叢集**動作存取您的 Amazon EKS 叢集並與之互動。如需詳細資訊，請參閱 [「部署到 Kubernetes 叢集」動作 YAML](deploy-action-ref-eks.md) 中的「[Role](deploy-action-ref-eks.md#deploy.action.eks.environment.connections.role)」主題。

  建立此角色之後，您必須將其新增至：
  + 您的 Kubernetes ConfigMap 檔案。若要了解如何將角色新增至 ConfigMap 檔案，請參閱《**Amazon EKS 使用者指南*》中的*[啟用叢集的 IAM 主體存取權](https://docs.aws.amazon.com/eks/latest/userguide/add-user-role.html)。
  + CodeCatalyst。若要了解如何將 IAM 角色新增至 CodeCatalyst，請參閱 [新增 IAM 角色至帳戶連線](ipa-connect-account-addroles.md)。
+ CodeCatalyst 空間、專案和環境。空間和環境都必須連線到您要部署應用程式的 AWS 帳戶。如需詳細資訊，請參閱[建立空間](spaces-create.md)、[在 Amazon CodeCatalyst 中建立空專案](projects-create.md#projects-create-empty)及[部署至 AWS 帳戶 和 VPCs](deploy-environments.md)。
+ CodeCatalyst 支援的來源儲存庫。儲存庫會存放您的應用程式來源檔案、Dockerfiles 和 Kubernetes 資訊清單。如需詳細資訊，請參閱[將程式碼與 CodeCatalyst 中的來源儲存庫一起存放和協作儲存程式碼並與來源儲存庫協作](source.md)。

------
#### [ Visual ]

**使用視覺化編輯器將 'Deploy 新增至 Kubernetes 叢集' 動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋**部署至 Kubernetes 叢集**動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**部署到 Kubernetes 叢集**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**下載**[以檢視動作的原始碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 在**輸入**和**組態**索引標籤中，根據您的需求完成欄位。如需每個欄位的說明，請參閱 [「部署到 Kubernetes 叢集」動作 YAML](deploy-action-ref-eks.md)。此參考提供在 YAML 和視覺化編輯器中顯示的每個欄位 （和對應的 YAML 屬性值） 的詳細資訊。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------
#### [ YAML ]

**使用 YAML 編輯器將 'Deploy 新增至 Kubernetes 叢集' 動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋**部署到 Kubernetes 叢集**動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**部署到 Kubernetes 叢集**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**下載**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 根據您的需求修改 YAML 程式碼中的屬性。中提供了每個可用屬性的說明[「部署到 Kubernetes 叢集」動作 YAML](deploy-action-ref-eks.md)。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------

# 「部署到 Kubernetes 叢集」變數
<a name="deploy-action-eks-variables"></a>

**部署至 Kubernetes 叢集**動作會在執行時間產生並設定下列變數。這些稱為*預先定義的變數*。

如需在工作流程中參考這些變數的資訊，請參閱 [使用預先定義的變數](workflows-using-predefined-variables.md)。


| 金鑰 | 值 | 
| --- | --- | 
|  叢集  |  在工作流程執行期間部署至 之 Amazon EKS 叢集 的 Amazon.com Resource Name (ARN)。 範例：`arn:aws:eks:us-west-2:111122223333:cluster/codecatalyst-eks-cluster`  | 
|  deployment-platform  |  部署平台的名稱。 硬式編碼為 `AWS:EKS`。  | 
|  中繼資料  |  預訂. 在工作流程執行期間所部署叢集的相關 JSON 格式中繼資料。  | 
|  命名空間  |  部署叢集的 Kubernetes 命名空間。 範例：`default`  | 
|  resources  |  預訂. 與工作流程執行期間部署的資源相關的 JSON 格式中繼資料。  | 
|  伺服器  |  您可以使用 等管理工具與叢集通訊的 API 伺服器端點名稱`kubectl`。 如需 API 服務端點的詳細資訊，請參閱《[Amazon EKS 使用者指南》中的 Amazon EKS 叢集端點存取控制](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html)。 **** 範例：`https://random-string.gr7.us-west-2.eks.amazonaws.com`  | 

# 「部署到 Kubernetes 叢集」動作 YAML
<a name="deploy-action-ref-eks"></a>

以下是**部署至 Kubernetes 叢集動作的 YAML **定義。若要了解如何使用此動作，請參閱 [使用工作流程部署至 Amazon EKS](deploy-action-eks.md)。

此動作定義以區段的形式存在於更廣泛的工作流程定義檔案中。如需有關此檔案的詳細資訊，請參閱[工作流程 YAML 定義](workflow-reference.md)。

**注意**  
下列大多數 YAML 屬性在視覺化編輯器中都有對應的 UI 元素。若要查詢 UI 元素，請使用 **Ctrl\$1F**。 元素會與其相關聯的 YAML 屬性一起列出。

```
# The workflow definition starts here.
# See 最上層屬性 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.   
  DeployToKubernetesCluster\$1nn: 
    Identifier: aws/kubernetes-deploy@v1
    DependsOn:
      - build-action
    Compute:  
        - Type: EC2 | Lambda
        - Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: DeployToEKS
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - manifest-artifact
    Configuration:
      Namespace: namespace
      Region: us-east-1 
      Cluster: eks-cluster
      Manifests: manifest-path
```

## DeployToKubernetesCluster
<a name="deploy.action.eks.name"></a>

(必要)

指定動作的名稱。工作流程中的所有動作名稱都必須是唯一的。動作名稱僅限於英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (\$1)。不允許空格。您不能使用引號在動作名稱中啟用特殊字元和空格。

預設：`DeployToKubernetesCluster_nn`。

對應的 UI：組態索引標籤/**動作顯示名稱**

## Identifier
<a name="deploy.action.eks.identifier"></a>

(*DeployToKubernetesCluster*/**Identifier**)

(必要)

識別 動作。除非您想要變更版本，否則請勿變更此屬性。如需詳細資訊，請參閱[指定要使用的動作版本](workflows-action-versions.md)。

預設：`aws/kubernetes-deploy@v1`。

對應的 UI：工作流程圖表/DeployToKubernetesCluster\$1nn/**aws/kubernetes-deploy@v1** 標籤

## DependsOn
<a name="deploy.action.eks.dependson"></a>

(*DeployToKubernetesCluster*/**DependsOn**)

(選用)

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

如需 'depends on' 功能的詳細資訊，請參閱 [定序動作](workflows-depends-on.md)。

對應的 UI：輸入索引標籤/**取決於 - 選用**

## Compute
<a name="deploy.action.eks.computename"></a>

(*DeployToKubernetesCluster*/**Compute**)

(選用)

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

對應的 UI：*無*

## Type
<a name="deploy.action.eks.computetype"></a>

(*DeployToKubernetesCluster*/Compute/**Type**)

（如果[Compute](#deploy.action.eks.computename)包含 則為必要）

運算引擎的類型。您可以使用下列其中一個值：
+ **EC2** （視覺化編輯器） 或 `EC2`(YAML 編輯器）

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

  最佳化動作啟動速度。

如需運算類型的更多相關資訊，請參閱[運算類型](workflows-working-compute.md#compute.types)。

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

## Fleet
<a name="deploy.action.eks.computefleet"></a>

(*DeployToKubernetesCluster*/Compute/**Fleet**)

(選用)

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

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

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

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

## Timeout
<a name="deploy.action.eks.timeout"></a>

(*DeployToKubernetesCluster*/**Timeout**)

(選用)

指定動作在 CodeCatalyst 結束動作之前可執行的時間，以分鐘為單位 (YAML 編輯器） 或小時和分鐘為單位。最小值為 5 分鐘，最大值如 中所述[CodeCatalyst 中工作流程的配額](workflows-quotas.md)。預設逾時與最大逾時相同。

對應的 UI：組態索引標籤/**逾時 - 選用 **

## Environment
<a name="deploy.action.eks.environment"></a>

(*DeployToKubernetesCluster*/**Environment**)

(必要)

指定要與 動作搭配使用的 CodeCatalyst 環境。動作會連線至所選環境中指定的 AWS 帳戶 和選用 Amazon VPC。動作會使用環境中指定的預設 IAM 角色來連線至 AWS 帳戶，並使用 [Amazon VPC 連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)中指定的 IAM 角色來連線至 Amazon VPC。

**注意**  
如果預設 IAM 角色沒有 動作所需的許可，您可以將 動作設定為使用不同的角色。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

如需環境的詳細資訊，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)和 [建立環境](deploy-environments-creating-environment.md)。

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

## Name
<a name="deploy.action.eks.environment.name"></a>

(*DeployToKubernetesCluster*/Environment/**Name**)

（如果[Environment](#deploy.action.eks.environment)包含 則為必要）

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

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

## Connections
<a name="deploy.action.eks.environment.connections"></a>

(*DeployToKubernetesCluster*/Environment/**Connections**)

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

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

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

如需帳戶連線的詳細資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。如需將帳戶連線新增至環境的相關資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Name
<a name="deploy.action.eks.environment.connections.name"></a>

(*DeployToKubernetesCluster*/Environment/Connections/**Name**)

(選用)

指定帳戶連線的名稱。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Role
<a name="deploy.action.eks.environment.connections.role"></a>

(*DeployToKubernetesCluster*/Environment/Connections/**Role**)

（如果[Connections](#deploy.action.eks.environment.connections)包含 則為必要）

指定**部署至 Kubernetes 叢集動作用來存取的 IAM **角色名稱 AWS。請確定您已[將角色新增至 CodeCatalyst 空間](ipa-connect-account-addroles.md)，且該角色包含下列政策。

如果您未指定 IAM 角色，則動作會使用 CodeCatalyst 主控台中[環境中](deploy-environments.md)列出的預設 IAM 角色。如果您在環境中使用預設角色，請確定其具有下列政策。
+ 下列許可政策：
**警告**  
將許可限制為下列政策中顯示的許可。使用具有更廣泛許可的角色可能會帶來安全風險。

------
#### [ JSON ]

****  

  ```
  {
      "Version":"2012-10-17",		 	 	 
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "eks:DescribeCluster",
                  "eks:ListClusters"
              ],
              "Resource": "*"
          }
      ]
  }
  ```

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

  ```
  "Resource": "*"
  ```
+ 下列自訂信任政策：

請確定此角色已新增至：
+ 您的帳戶連線。若要進一步了解如何將 IAM 角色新增至帳戶連線，請參閱 [新增 IAM 角色至帳戶連線](ipa-connect-account-addroles.md)。
+ 您的 Kubernetes ConfigMap。若要進一步了解如何將 IAM 角色新增至 ConfigMap，請參閱 `eksctl` 文件中的[管理 IAM 使用者和角色](https://eksctl.io/usage/iam-identity-mappings/)。

**提示**  
另請參閱 [教學課程：將應用程式部署至 Amazon EKS](deploy-tut-eks.md) ，以取得將 am IAM 角色新增至帳戶連線和 ConfigMap 的指示。

**注意**  
如有需要，您可以使用 `CodeCatalystWorkflowDevelopmentRole-spaceName`角色搭配此動作。如需有關此角色的詳細資訊，請參閱 [為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有可能造成安全風險的完整存取許可。我們建議您只在安全性較少的教學課程和案例中使用此角色。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**Role**

## Inputs
<a name="deploy.action.eks.inputs"></a>

(*DeployToKubernetesCluster*/**Inputs**)

（如果[Connections](#deploy.action.eks.environment.connections)包含 則為必要）

`Inputs` 區段定義工作流程執行期間 `DeployToKubernetesCluster`所需的資料。

**注意**  
每個**部署到 Amazon EKS **動作只允許一個輸入 （來源或成品）。

對應的 UI：**輸入**索引標籤

## Sources
<a name="deploy.action.eks.inputs.sources"></a>

(*DeployToKubernetesCluster*/Inputs/**Sources**)

（如果您的資訊清單檔案存放在來源儲存庫中，則為必要項目）

如果您的 Kubernetes 資訊清單檔案存放在來源儲存庫中，請指定該來源儲存庫的標籤。目前，唯一支援的標籤是 `WorkflowSource`。

如果您的資訊清單檔案不包含在來源儲存庫中，它們必須位於另一個動作所產生的成品中。

如需來源的詳細資訊，請參閱 [將來源儲存庫連線至工作流程](workflows-sources.md)。

對應的 UI：輸入索引標籤/**來源 - 選用**

## Artifacts - input
<a name="deploy.action.eks.inputs.artifacts"></a>

(*DeployToKubernetesCluster*/Inputs/**Artifacts**)

（如果您的資訊清單檔案存放在先前動作的[輸出成品](workflows-working-artifacts-output.md)中，則為必要）

如果 Kubernetes 資訊清單檔案或檔案包含在先前動作產生的成品中，請在此處指定該成品。如果您的資訊清單檔案不包含在成品中，則必須位於來源儲存庫中。

如需成品的詳細資訊，包括範例，請參閱 [在動作之間共用成品和檔案](workflows-working-artifacts.md)。

對應的 UI：組態索引標籤/**成品 - 選用**

## Configuration
<a name="deploy.action.eks.configuration"></a>

(*DeployToKubernetesCluster*/**Configuration**)

(必要)

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

對應的 UI：**組態**索引標籤

## Namespace
<a name="deploy.action.eks.namespace"></a>

(*DeployToKubernetesCluster*/Configuration/**Namespace**)

(選用)

指定要部署 Kubernetes 應用程式的 Kubernetes 命名空間。`default` 如果您未搭配叢集使用命名空間，請使用 。如需命名空間的詳細資訊，請參閱 [Kubernetes 文件中的使用 Kubernetes 命名空間細分叢集](https://kubernetes.io/docs/tasks/administer-cluster/namespaces/#subdividing-your-cluster-using-kubernetes-namespaces)。

如果您省略命名空間，`default`則會使用 的值。

對應的 UI：組態索引標籤/**命名空間**

## Region
<a name="deploy.action.eks.region"></a>

(*DeployToKubernetesCluster*/Configuration/**Region**)

(必要)

指定 Amazon EKS 叢集和服務所在的 AWS 區域。如需區域代碼清單，請參閱《》中的[區域端點](https://docs.aws.amazon.com/general/latest/gr/rande.html#region-names-codes)*AWS 一般參考*。

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

## Cluster
<a name="deploy.action.eks.cluster"></a>

(*DeployToKubernetesCluster*/Configuration/**Cluster**)

(必要)

指定現有 Amazon EKS 叢集的名稱。**部署至 Kubernetes 叢集**動作會將您的容器化應用程式部署至此叢集。如需 Amazon EKS 叢集的詳細資訊，請參閱《**Amazon EKS 使用者指南**》中的[叢集](https://docs.aws.amazon.com/eks/latest/userguide/clusters.html)。

對應的 UI：組態索引標籤/**叢集**

## Manifests
<a name="deploy.action.eks.manifest"></a>

(*DeployToKubernetesCluster*/Configuration/**Manifests**)

(必要)

在 Kubernetes 文件中指定 YAML 格式 Kubernetes 資訊清單檔案的路徑 （稱為*組態檔案*、*組態檔案*或簡稱*組態*)。

如果您使用的是多個資訊清單檔案，請將它們放在單一資料夾中，並參考該資料夾。資訊清單檔案是由 Kubernetes 以英數方式處理，因此請務必在檔案名稱前面加上數字或字母，以控制處理順序。例如：

`00-namespace.yaml`

`01-deployment.yaml`

如果您的資訊清單檔案位於來源儲存庫中，則路徑會與來源儲存庫根資料夾相對。如果檔案位於先前工作流程動作的成品中，則路徑會與成品根資料夾相對。

範例：

`Manifests/`

`deployment.yaml`

`my-deployment.yml`

請勿使用萬用字元 (`*`)。

**注意**  
不支援 [Helm Chart](https://helm.sh/docs/topics/charts/) 和 [kustomization 檔案](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/)。

如需資訊清單檔案的詳細資訊，請參閱 Kubernetes 文件中的[組織資源組態](https://kubernetes.io/docs/concepts/cluster-administration/manage-deployment/#organizing-resource-configurations)。

對應的 UI：組態索引標籤/**資訊清單**

# 部署 CloudFormation 堆疊
<a name="deploy-action-cfn"></a>

本節說明如何使用 CodeCatalyst 工作流程部署 AWS CloudFormation 堆疊。若要達成此目的，您必須將**部署 CloudFormation 堆疊**動作新增至工作流程。動作 AWS 會根據您提供的範本，將資源的 CloudFormation 堆疊部署至 。範本可以是：
+ CloudFormation 範本 – 如需詳細資訊，請參閱[使用 CloudFormation 範本](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html)。
+ AWS SAM 範本 – 如需詳細資訊，請參閱 [AWS Serverless Application Model (AWS SAM) 規格](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification.html)。
**注意**  
若要使用 AWS SAM 範本，您必須先使用 `[sam package](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-package.html)`操作封裝 AWS SAM 應用程式。如需示範如何在 Amazon CodeCatalyst 工作流程中自動執行此封裝的教學課程，請參閱 [教學課程：部署無伺服器應用程式](deploy-tut-lambda.md)。

如果堆疊已存在，動作會執行 CloudFormation `[CreateChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html)`操作，然後執行 `[ExecuteChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html)`操作。動作接著會等待變更部署，並根據結果將本身標記為失敗。

如果您已經有包含要部署之資源的 CloudFormation 或 AWS SAM 範本，或者您計劃使用 AWS SAM 和 等工具，在工作流程建置動作中自動產生資源，請使用**部署 CloudFormation 堆疊**動作[AWS Cloud Development Kit (AWS CDK)](https://docs.aws.amazon.com/cdk/latest/guide/home.html)。 [新增建置動作](build-add-action.md)

您可以在 CloudFormation 中編寫的範本，或 AWS SAM 可與**部署 CloudFormation 堆疊**動作搭配使用的範本，都沒有任何限制。

**提示**  
如需說明如何使用部署** CloudFormation 堆疊動作部署**無伺服器應用程式的教學課程，請參閱 [教學課程：部署無伺服器應用程式](deploy-tut-lambda.md)。

**Topics**
+ [「部署 CloudFormation 堆疊」動作所使用的執行期映像](#deploy-action-cfn-runtime)
+ [教學課程：部署無伺服器應用程式](deploy-tut-lambda.md)
+ [新增「部署 CloudFormation 堆疊」動作](deploy-action-cfn-adding.md)
+ [設定轉返](deploy-consumption-enable-alarms.md)
+ [「部署 CloudFormation 堆疊」變數](deploy-action-cfn-variables.md)
+ [「部署 CloudFormation 堆疊」動作 YAML](deploy-action-ref-cfn.md)

## 「部署 CloudFormation 堆疊」動作所使用的執行期映像
<a name="deploy-action-cfn-runtime"></a>

**部署 CloudFormation 堆疊**動作會在 [2022 年 11 月的映像](build-images.md#build.previous-image)上執行。如需詳細資訊，請參閱[作用中映像](build-images.md#build-curated-images)。

# 教學課程：部署無伺服器應用程式
<a name="deploy-tut-lambda"></a>

在本教學課程中，您將了解如何使用工作流程建置、測試和部署無伺服器應用程式做為 CloudFormation 堆疊。

本教學課程中的應用程式是一個簡單的 Web 應用程式，會輸出 'Hello World' 訊息。它包含 AWS Lambda 函數和 Amazon API Gateway，您可以使用 [AWS Serverless Application Model (AWS SAM)](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) 建置它，這是 的延伸[CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)。

**Topics**
+ [先決條件](#deploy-tut-lambda-cfn-prereqs)
+ [步驟 1：建立來源儲存庫](#deploy-tut-lambda-cfn-source)
+ [步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)
+ [步驟 3：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-lambda-cfn-roles-add)
+ [步驟 4：建立 Amazon S3 儲存貯體](#deploy-tut-lambda-cfn-s3)
+ [步驟 5：新增來源檔案](#deploy-tut-lambda-cfn-files)
+ [步驟 6：建立和執行工作流程](#deploy-tut-lambda-cfn-workflow)
+ [步驟 7：進行變更](#deploy-tut-lambda-cfn-change)
+ [清除](#deploy-tut-lambda-cfn-clean-up)

## 先決條件
<a name="deploy-tut-lambda-cfn-prereqs"></a>

開始之前：
+ 您需要具有連線 AWS 帳戶的 CodeCatalyst **空間**。如需詳細資訊，請參閱[建立空間](spaces-create.md)。
+ 在您的空間中，您需要一個名為 的空專案：

  ```
  codecatalyst-cfn-project
  ```

  使用**從頭開始**選項來建立此專案。

  如需詳細資訊，請參閱[在 Amazon CodeCatalyst 中建立空專案](projects-create.md#projects-create-empty)。
+ 在專案中，您需要名為 的 CodeCatalyst **環境**：

  ```
  codecatalyst-cfn-environment
  ```

  設定此環境，如下所示：
  + 選擇任何類型的，例如**非生產**。
  + 將您的帳戶連接到該 AWS 帳戶。
  + 針對**預設 IAM 角色**，選擇任何角色。稍後您將指定不同的角色。

  如需詳細資訊，請參閱[部署至 AWS 帳戶 和 VPCs](deploy-environments.md)。

## 步驟 1：建立來源儲存庫
<a name="deploy-tut-lambda-cfn-source"></a>

在此步驟中，您會在 CodeCatalyst 中建立來源儲存庫。此儲存庫用於存放教學課程的來源檔案，例如 Lambda 函數檔案。

如需來源儲存庫的詳細資訊，請參閱 [建立來源儲存庫](source-repositories-create.md)。

**建立來源儲存庫**

1. 在 CodeCatalyst 的導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**。

1. 選擇**新增儲存庫**，然後選擇**建立儲存庫**。

1. 在**儲存庫名稱**中，輸入：

   ```
   codecatalyst-cfn-source-repository
   ```

1. 選擇**建立**。

您現在已建立名為 的儲存庫`codecatalyst-cfn-source-repository`。

## 步驟 2：建立 AWS 角色
<a name="deploy-tut-lambda-cfn-roles"></a>

在此步驟中，您會建立下列 AWS IAM 角色：
+ **部署角色** – 授予 CodeCatalyst **部署 CloudFormation 堆疊**動作許可，以存取您將部署無伺服器應用程式的 AWS 帳戶和 CloudFormation 服務。**部署 CloudFormation 堆疊**動作是工作流程的一部分。
+ **組建角色** – 授予 CodeCatalyst 組建動作許可，以存取 AWS 您的帳戶並寫入 Amazon S3，其中將存放無伺服器應用程式套件。建置動作是工作流程的一部分。
+ **堆疊角色** – 授予 CloudFormation 許可，以讀取和修改稍後將提供之 AWS SAM 範本中指定的資源。同時授予 CloudWatch 許可。

如需 IAM 角色的詳細資訊，請參閱*AWS Identity and Access Management 《 使用者指南*》中的 [IAM 角色](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)。

**注意**  
若要節省時間，您可以建立稱為角色的單一`CodeCatalystWorkflowDevelopmentRole-spaceName`角色，而不是先前列出的三個角色。如需詳細資訊，請參閱[為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有非常廣泛的許可，可能會帶來安全風險。我們建議您只在安全性較少的教學課程和案例中使用此角色。本教學假設您正在建立先前列出的三個角色。

**注意**  
[Lambda 執行角色](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html)也是必要的，但您不需要立即建立，因為`sam-template.yml`檔案會在步驟 5 中執行工作流程時為您建立。



**建立部署角色**

1. 建立角色的政策，如下所示：

   1. 登入 AWS。

   1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。

   1. 在導覽窗格中，選擇**政策**。

   1. 選擇 **Create policy** (建立政策)。

   1. 請選擇 **JSON** 標籤。

   1. 刪除現有的程式碼。

   1. 貼上以下程式碼：
**注意**  
第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元，然後在資源名稱可用後縮小政策的範圍。  

      ```
      "Resource": "*"
      ```

   1. 選擇下**一步：標籤**。

   1. 選擇下**一步：檢閱**。

   1. 在**名稱**中，輸入：

      ```
      codecatalyst-deploy-policy
      ```

   1. 選擇**建立政策**。

      您現在已建立許可政策。

1. 建立部署角色，如下所示：

   1. 在導覽窗格中，選擇**角色**，然後選擇**建立角色**。

   1. 選擇**自訂信任政策**。

   1. 刪除現有的自訂信任政策。

   1. 新增下列自訂信任政策：

   1. 選擇**下一步**。

   1. 在**許可政策**中，搜尋`codecatalyst-deploy-policy`並選取其核取方塊。

   1. 選擇**下一步**。

   1. 針對**角色名稱**，輸入：

      ```
      codecatalyst-deploy-role
      ```

   1. 針對**角色描述**，輸入：

      ```
      CodeCatalyst deploy role
      ```

   1. 選擇建**立角色**。

   您現在已建立具有信任政策和許可政策的部署角色。

1. 取得部署角色 ARN，如下所示：

   1. 在導覽窗格中，選擇**角色**。

   1. 在搜尋方塊中，輸入您剛建立的角色名稱 (`codecatalyst-deploy-role`)。

   1. 從清單中選擇角色。

      角色的**摘要**頁面隨即出現。

   1. 在頂端複製 **ARN** 值。

   您現在已建立具有適當許可的部署角色，並取得其 ARN。

**建立建置角色**

1. 建立角色的政策，如下所示：

   1. 登入 AWS。

   1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。

   1. 在導覽窗格中，選擇**政策**。

   1. 選擇 **Create policy** (建立政策)。

   1. 請選擇 **JSON** 標籤。

   1. 刪除現有的程式碼。

   1. 貼上以下程式碼：
**注意**  
第一次使用該角色執行工作流程動作時，請在資源政策陳述式中使用萬用字元，然後在資源名稱可用後縮小政策的範圍。  

      ```
      "Resource": "*"
      ```

   1. 選擇下**一步：標籤**。

   1. 選擇下**一步：檢閱**。

   1. 在**名稱**中，輸入：

      ```
      codecatalyst-build-policy
      ```

   1. 選擇**建立政策**。

      您現在已建立許可政策。

1. 建立建置角色，如下所示：

   1. 在導覽窗格中，選擇**角色**，然後選擇**建立角色**。

   1. 選擇**自訂信任政策**。

   1. 刪除現有的自訂信任政策。

   1. 新增下列自訂信任政策：

   1. 選擇**下一步**。

   1. 在**許可政策**中，搜尋`codecatalyst-build-policy`並選取其核取方塊。

   1. 選擇**下一步**。

   1. 針對**角色名稱**，輸入：

      ```
      codecatalyst-build-role
      ```

   1. 針對**角色描述**，輸入：

      ```
      CodeCatalyst build role
      ```

   1. 選擇建**立角色**。

   您現在已建立具有信任政策和許可政策的建置角色。

1. 取得建置角色 ARN，如下所示：

   1. 在導覽窗格中，選擇**角色**。

   1. 在搜尋方塊中，輸入您剛建立的角色名稱 (`codecatalyst-build-role`)。

   1. 從清單中選擇角色。

      角色的**摘要**頁面隨即出現。

   1. 在頂端複製 **ARN** 值。

   您現在已建立具有適當許可的建置角色，並取得其 ARN。<a name="deploy-tut-lambda-cfn-roles-stack"></a>

**建立堆疊角色**

1.  AWS 使用您要部署堆疊的帳戶登入 。

1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。

1. 建立堆疊角色，如下所示：

   1. 在導覽窗格中，選擇 **Roles** (角色)。

   1. 選擇 **Create Role** (建立角色)。

   1. 選擇 **AWS 服務**。

   1. 在**使用案例**區段中，從下拉式清單中選擇 **CloudFormation**。

   1. 選取 **CloudFormation** 選項按鈕。

   1. 在底部，選擇**下一步**。

   1. 使用搜尋方塊，尋找下列許可政策，然後選取其各自的核取方塊。
**注意**  
如果您搜尋政策但未顯示，請務必選擇**清除篩選條件**，然後再試一次。
      + **CloudWatchFullAccess**
      + **AWS CloudFormationFullAccess**
      + **IAMFullAccess**
      + **AWS Lambda\$1FullAccess**
      + **AmazonAPIGatewayAdministrator**
      + **AmazonS3FullAccess**
      + **AmazonEC2ContainerRegistryFullAccess**

      第一個政策允許存取 CloudWatch，以便在警示發生時啟用堆疊轉返。

      其餘政策允許 AWS SAM 存取本教學課程中將部署的堆疊中的服務和資源。如需詳細資訊，請參閱《 *AWS Serverless Application Model 開發人員指南*》中的[許可](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-permissions.html)。

   1. 選擇**下一步**。

   1. 針對**角色名稱**，輸入：

      ```
      codecatalyst-stack-role
      ```

   1. 選擇建**立角色**。

1. 取得堆疊角色的 ARN，如下所示：

   1. 在導覽窗格中，選擇**角色**。

   1. 在搜尋方塊中，輸入您剛建立的角色名稱 (`codecatalyst-stack-role`)。

   1. 從清單中選擇角色。

   1. 在**摘要**區段中，複製 **ARN** 值。供稍後使用。

   您現在已建立具有適當許可的堆疊角色，並且已取得其 ARN。

## 步驟 3：將 AWS 角色新增至 CodeCatalyst
<a name="deploy-tut-lambda-cfn-roles-add"></a>

在此步驟中，您將建置角色 (`codecatalyst-build-role`) 和部署角色 (`codecatalyst-deploy-role`) 新增至您空間中的 CodeCatalyst 帳戶連線。

**注意**  
您不需要將堆疊角色 (`codecatalyst-stack-role`) 新增至連線。這是因為 *CloudFormation* （非 CodeCatalyst) 使用堆疊角色，在 CodeCatalyst 與 AWS 使用部署角色之間建立連線*之後*。由於 CodeCatalyst 不會使用堆疊角色來存取 AWS，因此不需要與帳戶連線建立關聯。

**將建置和部署角色新增至您的帳戶連線**

1. 在 CodeCatalyst 中，導覽至您的空間。

1. 選擇**AWS 帳戶**。帳戶連線清單隨即顯示。

1. 選擇代表您建立建置和部署角色 AWS 的帳戶的帳戶連線。

1. **從管理主控台選擇 AWS 管理角色**。

   將 **IAM 角色新增至 Amazon CodeCatalyst 空間**頁面隨即出現。您可能需要登入才能存取頁面。

1. 選取**新增您在 IAM 中建立的現有角色**。

   下拉式清單隨即出現。清單會顯示具有信任政策的所有 IAM 角色，其中包含 `codecatalyst-runner.amazonaws.com``codecatalyst.amazonaws.com`和服務主體。

1. 在下拉式清單中，選擇 `codecatalyst-build-role`，然後選擇**新增角色**。

1. 選擇**新增 IAM 角色**，選擇**新增您在 IAM 中建立的現有角色**，然後在下拉式清單中選擇 `codecatalyst-deploy-role`。選擇 **Add role (新增角色)**。

   您現在已將建置和部署角色新增至您的空間。

1. 複製 **Amazon CodeCatalyst 顯示名稱**的值。稍後建立工作流程時，您將需要此值。

## 步驟 4：建立 Amazon S3 儲存貯體
<a name="deploy-tut-lambda-cfn-s3"></a>

在此步驟中，您會建立 Amazon S3 儲存貯體，存放無伺服器應用程式的部署套件 .zip 檔案。

**建立 Amazon S3 儲存貯體**

1. 開啟位於 [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/) 的 Amazon S3 主控台。

1. 在主窗格中，選擇**建立儲存貯**體。

1. 針對**儲存貯體名稱**，輸入：

   ```
   codecatalyst-cfn-s3-bucket
   ```

1. 對於 **AWS 區域**，選擇一個區域。本教學假設您選擇了**美國西部 （奧勒岡） us-west-2**。如需 Amazon S3 支援之區域的相關資訊，請參閱《》中的 [Amazon Simple Storage Service 端點和配額](https://docs.aws.amazon.com/general/latest/gr/s3.html)*AWS 一般參考*。

1. 在頁面底部，選擇**建立儲存貯**體。

您現在在美國西部 （奧勒岡） us-west-2 區域中建立名為 **codecatalyst-cfn-s3-bucket**的儲存貯體。

## 步驟 5：新增來源檔案
<a name="deploy-tut-lambda-cfn-files"></a>

在此步驟中，您會將數個應用程式來源檔案新增至 CodeCatalyst 來源儲存庫。`hello-world` 資料夾包含您將部署的應用程式檔案。`tests` 資料夾包含單元測試。資料夾結構如下所示：

```
.
|— hello-world
|  |— tests
|     |— unit
|        |— test-handler.js
|  |— app.js
|— .npmignore
|— package.json
|— sam-template.yml
|— setup-sam.sh
```

### .npmignore 檔案
<a name="deploy-tut-lambda-cfn-files-npmignore"></a>

`.npmignore` 檔案指出哪些檔案和資料夾 npm 應該從應用程式套件中排除。在本教學課程中，npm 會排除 `tests` 資料夾，因為它不是應用程式的一部分。

**新增 .npmignore 檔案**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案， `codecatalyst-cfn-project`

1. 在導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**。

1. 從來源儲存庫清單中，選擇您的儲存庫 `codecatalyst-cfn-source-repository`。

1. 在**檔案中**，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   .npmignore
   ```

1. 在文字方塊中，輸入下列程式碼：

   ```
   tests/*
   ```

1. 選擇**遞交**，然後再次選擇**遞交**。

   您現在已在儲存庫的根`.npmignore`目錄中建立名為 的檔案。

### package.json 檔案
<a name="deploy-tut-lambda-cfn-files-package-json"></a>

`package.json` 檔案包含有關節點專案的重要中繼資料，例如專案名稱、版本編號、描述、相依性，以及描述如何與應用程式互動和執行的其他詳細資訊。

本教學`package.json`課程中的 包含相依性和`test`指令碼的清單。測試指令碼會執行下列動作：
+ 使用 [mocha](https://mochajs.org/)，測試指令碼會執行 中指定的單元測試，`hello-world/tests/unit/`並使用 [xunit]() 報告程式將結果寫入`junit.xml`檔案。
+ 使用[伊斯坦堡 (nyc)](https://istanbul.js.org/)，測試指令碼會使用 [clover](https://openclover.org/doc/manual/4.2.0/general--about-openclover.html) 報告程式產生程式碼涵蓋範圍報告 (`clover.xml`)。如需詳細資訊，請參閱伊斯坦堡文件中[的使用替代報告程式](https://istanbul.js.org/docs/advanced/alternative-reporters/#clover)。

**新增 package.json 檔案**

1. 在儲存庫的**檔案中**，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   package.json
   ```

1. 在文字方塊中，輸入下列程式碼：

   ```
   {
     "name": "hello_world",
     "version": "1.0.0",
     "description": "hello world sample for NodeJS",
     "main": "app.js",
     "repository": "https://github.com/awslabs/aws-sam-cli/tree/develop/samcli/local/init/templates/cookiecutter-aws-sam-hello-nodejs",
     "author": "SAM CLI",
     "license": "MIT",
     "dependencies": {
       "axios": "^0.21.1",
       "nyc": "^15.1.0"
     },
     "scripts": {
       "test": "nyc --reporter=clover mocha hello-world/tests/unit/ --reporter xunit --reporter-option output=junit.xml"
     },
     "devDependencies": {
       "aws-sdk": "^2.815.0",
       "chai": "^4.2.0",
       "mocha": "^8.2.1"
     }
   }
   ```

1. 選擇**遞交**，然後再次選擇**遞交**。

   您現在已將名為 的檔案新增至儲存庫的`package.json`根目錄。

### sam-template.yml 檔案
<a name="deploy-tut-lambda-cfn-files-sam-template-yml"></a>

`sam-template.yml` 檔案包含部署 Lambda 函數和 API Gateway 並將其一起設定的指示。它遵循[AWS Serverless Application Model 範本規格](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification.html)，擴展 CloudFormation 範本規格。

您在本教學課程中使用 AWS SAM 範本，而不是一般 CloudFormation 範本，因為 AWS SAM 提供實用的 [AWS：：Serverless：：Function](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html) 資源類型。此類型會執行許多behind-the-scenes組態，您通常必須將其寫入才能使用基本 CloudFormation 語法。例如， `AWS::Serverless::Function`會建立 Lambda 函數、Lambda 執行角色，以及啟動函數的事件來源映射。如果您想要使用基本 CloudFormation 進行寫入，則必須將所有程式碼編寫。

雖然本教學課程使用預先編寫的範本，但您可以使用建置動作在工作流程中產生範本。如需詳細資訊，請參閱[部署 CloudFormation 堆疊](deploy-action-cfn.md)。

**新增 sam-template.yml 檔案**

1. 在儲存庫的**檔案中**，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   sam-template.yml
   ```

1. 在文字方塊中，輸入下列程式碼：

   ```
   AWSTemplateFormatVersion: '2010-09-09'
   Transform: AWS::Serverless-2016-10-31
   Description: >
     serverless-api
   
     Sample SAM Template for serverless-api
     
   # More info about Globals: https://github.com/awslabs/serverless-application-model/blob/master/docs/globals.rst
   Globals:
     Function:
       Timeout: 3
   
   Resources:
     HelloWorldFunction:
       Type: AWS::Serverless::Function # For details on this resource type, see https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
       Properties:
         CodeUri: hello-world/
         Handler: app.lambdaHandler
         Runtime: nodejs12.x
         Events:
           HelloWorld:
             Type: Api # For details on this event source type, see https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
             Properties:
               Path: /hello
               Method: get
   
   Outputs:
     # ServerlessRestApi is an implicit API created out of the events key under Serverless::Function
     # Find out about other implicit resources you can reference within AWS SAM at
     # https://github.com/awslabs/serverless-application-model/blob/master/docs/internals/generated_resources.rst#api
     HelloWorldApi:
       Description: "API Gateway endpoint URL for the Hello World function"
       Value: !Sub "https://${ServerlessRestApi}.execute-api.${AWS::Region}.amazonaws.com/Prod/hello/"
     HelloWorldFunction:
       Description: "Hello World Lambda function ARN"
       Value: !GetAtt HelloWorldFunction.Arn
     HelloWorldFunctionIamRole:
       Description: "Implicit Lambda execution role created for the Hello World function"
       Value: !GetAtt HelloWorldFunctionRole.Arn
   ```

1. 選擇**遞交**，然後再次選擇**遞交**。

   您現在已在儲存庫的根資料夾`sam-template.yml`下新增名為 的檔案。

### setup-sam.sh 檔案
<a name="deploy-tut-lambda-cfn-files-setup-sam"></a>

`setup-sam.sh` 檔案包含下載和安裝 CLI AWS SAM 公用程式的指示。工作流程會使用此公用程式來封裝`hello-world`來源。

**新增 setup-sam.sh 檔案**

1. 在儲存庫的**檔案中**，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   setup-sam.sh
   ```

1. 在文字方塊中，輸入下列程式碼：

   ```
   #!/usr/bin/env bash
   echo "Setting up sam"
   
   yum install unzip -y
   
   curl -LO https://github.com/aws/aws-sam-cli/releases/latest/download/aws-sam-cli-linux-x86_64.zip
   unzip -qq aws-sam-cli-linux-x86_64.zip -d sam-installation-directory
   
   ./sam-installation-directory/install; export AWS_DEFAULT_REGION=us-west-2
   ```

   在上述程式碼中，將 AWS *us-west-2* 取代為您的 區域。

1. 選擇**遞交**，然後再次選擇**遞交**。

   您現在已將名為 的檔案新增至儲存庫的`setup-sam.sh`根目錄。

### app.js 檔案
<a name="deploy-tut-lambda-cfn-files-app-js"></a>

`app.js` 包含 Lambda 函數程式碼。在本教學課程中，程式碼會傳回文字 `hello world`。

**新增 app.js 檔案**

1. 在儲存庫的**檔案中**，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   hello-world/app.js
   ```

1. 在文字方塊中，輸入下列程式碼：

   ```
   // const axios = require('axios')
   // const url = 'http://checkip.amazonaws.com/';
   let response;
   
   /**
    *
    * Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
    * @param {Object} event - API Gateway Lambda Proxy Input Format
    *
    * Context doc: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-context.html 
    * @param {Object} context
    *
    * Return doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html
    * @returns {Object} object - API Gateway Lambda Proxy Output Format
    * 
    */
   exports.lambdaHandler = async (event, context) => {
       try {
           // const ret = await axios(url);
           response = {
               'statusCode': 200,
               'body': JSON.stringify({
                   message: 'hello world',
                   // location: ret.data.trim()
               })
           }
       } catch (err) {
           console.log(err);
           return err;
       }
   
       return response
   };
   ```

1. 選擇**遞交**，然後再次選擇**遞交**。

   您現在已建立名為 的資料夾`hello-world`和名為 的檔案`app.js`。

### test-handler.js 檔案
<a name="deploy-tut-lambda-cfn-files-test-handler-js"></a>

`test-handler.js` 檔案包含 Lambda 函數的單位測試。

**新增 test-handler.js 檔案**

1. 在儲存庫的**檔案中**，選擇**建立檔案**。

1. 針對**檔案名稱**，輸入：

   ```
   hello-world/tests/unit/test-handler.js
   ```

1. 在文字方塊中，輸入下列程式碼：

   ```
   'use strict';
   
   const app = require('../../app.js');
   const chai = require('chai');
   const expect = chai.expect;
   var event, context;
   
   describe('Tests index', function () {
       it('verifies successful response', async () => {
           const result = await app.lambdaHandler(event, context)
   
           expect(result).to.be.an('object');
           expect(result.statusCode).to.equal(200);
           expect(result.body).to.be.an('string');
   
           let response = JSON.parse(result.body);
   
           expect(response).to.be.an('object');
           expect(response.message).to.be.equal("hello world");
           // expect(response.location).to.be.an("string");
       });
   });
   ```

1. 選擇**遞交**，然後再次選擇**遞交**。

   您現在已在 `hello-world/tests/unit` 資料夾`test-handler.js`下新增名為 的檔案。

您現在已新增所有來源檔案。

花一點時間仔細檢查您的工作，並確保將所有檔案放在正確的資料夾中。資料夾結構如下所示：

```
.
|— hello-world
|  |— tests
|     |— unit
|        |— test-handler.js
|  |— app.js
|— .npmignore
|— README.md
|— package.json
|— sam-template.yml
|— setup-sam.sh
```

## 步驟 6：建立和執行工作流程
<a name="deploy-tut-lambda-cfn-workflow"></a>

在此步驟中，您建立的工作流程會封裝您的 Lambda 原始程式碼並進行部署。工作流程包含下列依順序執行的建置區塊：
+ 觸發條件 – 當您將變更推送至來源儲存庫時，此觸發條件會自動啟動工作流程執行。關於觸發條件的詳細資訊，請參閱 [使用觸發程序自動啟動工作流程執行](workflows-add-trigger.md)。
+ 測試動作 (`Test`) – 在觸發時，此動作會安裝 [Node 套件管理員 (npm)](https://www.npmjs.com/)，然後執行 `npm run test`命令。此命令會告知 npm 執行 `package.json` 檔案中定義的`test`指令碼。`test` 指令碼接著會執行單元測試，並產生兩個報告：測試報告 (`junit.xml`) 和程式碼涵蓋報告 (`clover.xml`)。如需詳細資訊，請參閱[package.json 檔案](#deploy-tut-lambda-cfn-files-package-json)。

  接下來，測試動作會將 XML 報告轉換為 CodeCatalyst 報告，並在測試動作**的報告**索引標籤下顯示在 CodeCatalyst 主控台中。

  如需測試動作的詳細資訊，請參閱 [使用工作流程進行測試使用工作流程進行測試](test-workflow-actions.md)。
+ 建置動作 (`BuildBackend`) – 測試動作完成後，建置動作會下載並安裝 AWS SAM CLI、封裝`hello-world`來源，並將套件複製到 Amazon S3 儲存貯體，Lambda 服務預期會是該儲存貯體。動作也會輸出名為 的新 AWS SAM 範本檔案，`sam-template-packaged.yml`並將其置於名為 的輸出成品中`buildArtifact`。

  如需建置動作的詳細資訊，請參閱 [使用工作流程建置](build-workflow-actions.md)。
+ 部署動作 (`DeployCloudFormationStack`) – 完成建置動作後，部署動作會尋找建置動作 (`buildArtifact`) 產生的輸出成品，在其中尋找 AWS SAM 範本，然後執行範本。 AWS SAM 範本會建立可部署無伺服器應用程式的堆疊。

**建立工作流程**

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇**建立工作流程**。

1. 針對**來源儲存庫**，選擇 `codecatalyst-cfn-source-repository`。

1. 針對**分支**，選擇 `main`。

1. 選擇**建立**。

1. 刪除 YAML 範例程式碼。

1. 新增下列 YAML 程式碼：
**注意**  
在下列 YAML 程式碼中，您可以視需要省略這些`Connections:`區段。如果您省略這些區段，您必須確保環境中**預設 IAM 角色**欄位中指定的角色包含 中所述兩個角色的許可和信任政策[步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。如需使用預設 IAM 角色設定環境的詳細資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

   ```
   Name: codecatalyst-cfn-workflow
   SchemaVersion: 1.0
   
   Triggers:
     - Type: PUSH
       Branches:
         - main   
   Actions:
     Test:
       Identifier: aws/managed-test@v1
       Inputs:
         Sources:
           - WorkflowSource
       Outputs:
         Reports:
           CoverageReport:
             Format: CLOVERXML
             IncludePaths:
               - "coverage/*"
           TestReport:
             Format: JUNITXML
             IncludePaths:
               - junit.xml
       Configuration:
         Steps:
           - Run: npm install
           - Run: npm run test  
     BuildBackend:
       Identifier: aws/build@v1
       DependsOn:
         - Test
       Environment:
         Name: codecatalyst-cfn-environment
         Connections:
           - Name: codecatalyst-account-connection
             Role: codecatalyst-build-role
       Inputs:
         Sources:
           - WorkflowSource
       Configuration: 
         Steps:
           - Run: . ./setup-sam.sh
           - Run: sam package --template-file sam-template.yml --s3-bucket codecatalyst-cfn-s3-bucket --output-template-file sam-template-packaged.yml --region us-west-2
       Outputs:
         Artifacts:
           - Name: buildArtifact
             Files:
               - "**/*"
     DeployCloudFormationStack:
       Identifier: aws/cfn-deploy@v1
       DependsOn: 
         - BuildBackend
       Environment:
         Name: codecatalyst-cfn-environment
         Connections:
           - Name: codecatalyst-account-connection
             Role: codecatalyst-deploy-role
       Inputs:
         Artifacts:
           - buildArtifact
         Sources: []
       Configuration:
         name: codecatalyst-cfn-stack
         region: us-west-2
         role-arn: arn:aws:iam::111122223333:role/StackRole
         template: ./sam-template-packaged.yml
         capabilities: CAPABILITY_IAM,CAPABILITY_AUTO_EXPAND
   ```

   在上述程式碼中，取代：
   + 兩個具有您環境名稱的 *codecatalyst-cfn-environment* 執行個體。
   + 這兩個 *codecatalyst-account-connection* 執行個體都具有您帳戶連線的顯示名稱。顯示名稱可能是數字。如需詳細資訊，請參閱[步驟 3：將 AWS 角色新增至 CodeCatalyst](#deploy-tut-lambda-cfn-roles-add)。
   + *codecatalyst-build-role* 使用您在 中建立的建置角色名稱[步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。
   + *codecatalyst-cfn-s3-bucket*，內含您在 中建立的 Amazon S3 儲存貯體名稱[步驟 4：建立 Amazon S3 儲存貯體](#deploy-tut-lambda-cfn-s3)。
   + Amazon S3 儲存貯體所在的區域 （第一個執行個體） 和堆疊將部署的區域 （第二個執行個體） 為 *us-west-2* 的兩個執行個體。這些區域可能不同。本教學假設兩個區域都設為 `us-west-2`。如需 Amazon S3 和 支援區域的詳細資訊 CloudFormation，請參閱《》中的[服務端點和配額](https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html)*AWS 一般參考*。
   + *codecatalyst-deploy-role* 使用您在 中建立的部署角色名稱[步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。
   + *codecatalyst-cfn-environment*，其中包含您在 中建立的環境名稱[先決條件](#deploy-tut-lambda-cfn-prereqs)。
   + *arn：aws：iam：：111122223333：role/StackRole*，其中包含您在 中建立之堆疊角色的 Amazon Resource Name (ARN)[步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。
**注意**  
如果您決定不建立建置、部署和堆疊角色，請將 *codecatalyst-build-role*、 *codecatalyst-deploy-role*和 *arn：aws：iam：：111122223333：role/StackRole* 取代為`CodeCatalystWorkflowDevelopmentRole-spaceName`角色的名稱或 ARN。如需有關此角色的詳細資訊，請參閱 [步驟 2：建立 AWS 角色](#deploy-tut-lambda-cfn-roles)。

   如需先前所示程式碼中屬性的相關資訊，請參閱 [「部署 CloudFormation 堆疊」動作 YAML](deploy-action-ref-cfn.md)。

1. （選用） 選擇**驗證**，以確保 YAML 程式碼在遞交之前有效。

1. 選擇 **Commit** (遞交)。

1. 在**遞交工作流程**對話方塊中，輸入下列內容：

   1. 對於**工作流程檔案名稱**，請保留預設值 `codecatalyst-cfn-workflow`。

   1. 針對**遞交訊息**，輸入：

      ```
      add initial workflow file
      ```

   1. 針對**儲存庫**，選擇 **codecatalyst-cfn-source-repository**。

   1. 針對**分支名稱**，選擇**主要**。

   1. 選擇 **Commit** (遞交)。

   您現在已建立工作流程。由於工作流程頂端定義的觸發條件，工作流程執行會自動啟動。具體而言，當您將`codecatalyst-cfn-workflow.yaml`檔案遞交 （並推送） 到您的來源儲存庫時，觸發會啟動工作流程執行。

**檢視進行中工作流程執行**

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇您剛建立的工作流程：`codecatalyst-cfn-workflow`。

1. 選擇**執行**索引標籤。

1. 在**執行 ID** 欄中，選擇執行 ID。

1. 選擇**測試**以查看測試進度。

1. 選擇 **BuildBackend** 以查看建置進度。

1. 選擇 **DeployCloudFormationStack** 以查看部署進度。

   如需檢視執行詳細資訊的詳細資訊，請參閱 [檢視工作流程執行狀態和詳細資訊](workflows-view-run.md)。

1. 當 **DeployCloudFormationStack** 動作完成時，請執行下列動作：
   + 如果工作流程執行成功，請前往下一個程序。
   + 如果工作流程在**測試**或 **BuildBackend** 動作上執行失敗，請選擇**日誌**來疑難排解問題。
   + 如果在 **DeployCloudFormationStack** 動作上執行工作流程失敗，請選擇部署動作，然後選擇**摘要**索引標籤。捲動至 **CloudFormation 事件**區段以檢視詳細的錯誤訊息。如果發生轉返，請在重新執行工作流程之前，透過 中的 AWS CloudFormation 主控台刪除`codecatalyst-cfn-stack`堆疊。

**驗證部署**

1. 成功部署後，從頂端附近的水平選單列中選擇**變數 (7)**。（請勿在右側窗格中選擇**變數**。)

1. 在 **HelloWorldApi** 旁邊，將 `https://` URL 貼到瀏覽器。

   隨即顯示來自 Lambda 函數的 **hello world** JSON 訊息，指出工作流程已成功部署和設定 Lambda 函數和 API Gateway。
**提示**  
您可以使用幾個小型組態，讓 CodeCatalyst 在工作流程圖表中顯示此 URL。如需詳細資訊，請參閱[在工作流程圖表中顯示應用程式 URL](deploy-app-url.md)。

**驗證單位測試結果和程式碼涵蓋範圍**

1. 在工作流程圖表中，選擇**測試**，然後選擇**報告**。

1. 選擇 **TestReport** 以檢視單位測試結果，或選擇 **CoverageReport** 以檢視測試中檔案的程式碼涵蓋範圍詳細資訊，在此情況下為 `app.js`和 `test-handler.js`。

**驗證已部署的資源**

1. 登入 AWS 管理主控台 並開啟 API Gateway 主控台，網址為 https：//[https://console.aws.amazon.com/apigateway/](https://console.aws.amazon.com/apigateway/)。

1. 觀察 AWS SAM 範本建立的 **codecatalyst-cfn-stack** API。API 名稱來自工作流程定義檔案 () 中的 `Configuration/name`值`codecatalyst-cfn-workflow.yaml`。

1. 在 https：//[https://console.aws.amazon.com/lambda/](https://console.aws.amazon.com/lambda/) 開啟 AWS Lambda 主控台。

1. 在導覽視窗中，選擇**函數**。

1. 選擇您的 Lambda 函數 `codecatalyst-cfn-stack-HelloWorldFunction-string`。

1. 您可以查看 API Gateway 如何觸發函數。此整合是由 資源類型自動設定 AWS SAM `AWS::Serverless::Function`。

## 步驟 7：進行變更
<a name="deploy-tut-lambda-cfn-change"></a>

在此步驟中，您會變更並遞交 Lambda 原始程式碼。此遞交會啟動新的工作流程執行。此執行會使用 Lambda 主控台中指定的預設流量轉移組態，在藍綠配置中部署新的 Lambda 函數。

**變更您的 Lambda 來源**

1. 在 CodeCatalyst 中，導覽至您的專案。

1. 在導覽窗格中，選擇**程式碼**，然後選擇**來源儲存庫**。

1. 選擇您的來源儲存庫 `codecatalyst-cfn-source-repository`。

1. 變更應用程式檔案：

   1. 選擇 `hello-world` 資料夾。

   1. 選擇 `app.js` 檔案。

   1. 選擇**編輯**。

   1. 在第 23 行，`hello world`變更為 **Tutorial complete\$1**。

   1. 選擇**遞交**，然後再次選擇**遞交**。

      遞交會導致工作流程執行開始。此執行將會失敗，因為您尚未更新單元測試以反映名稱變更。

1. 更新單元測試：

   1. 選擇 `hello-world\tests\unit\test-handler.js`。

   1. 選擇**編輯**。

   1. 在第 19 行，`hello world`變更為 **Tutorial complete\$1**。

   1. 選擇**遞交**，然後再次選擇**遞交**。

      遞交會導致另一個工作流程執行開始。此執行將會成功。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇 `codecatalyst-cfn-workflow`，然後選擇**執行**。

1. 選擇最新執行的執行 ID。它應該仍在進行中。

1. 選擇**測試**、 **BuildBackend** 和 **DeployCloudFormationStack** 以查看工作流程執行進度。

1. 當工作流程完成時，請選擇頂端附近的**變數 (7)**。

1. 在 **HelloWorldApi** 旁邊，將 `https://` URL 貼到瀏覽器中。

   瀏覽器中會出現一`Tutorial complete!`則訊息，指出您的新應用程式已成功部署。

## 清除
<a name="deploy-tut-lambda-cfn-clean-up"></a>

清除本教學課程中使用的檔案和服務，以避免收取這些檔案和服務的費用。

**在 CodeCatalyst 主控台中清除**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 刪除 `codecatalyst-cfn-workflow`。

1. 刪除 `codecatalyst-cfn-environment`。

1. 刪除 `codecatalyst-cfn-source-repository`。

1. 刪除 `codecatalyst-cfn-project`。

**在 中清除 AWS 管理主控台**

1. 在 CloudFormation 中清除，如下所示：

   1. 在 https：//[https://console.aws.amazon.com/cloudformation](https://console.aws.amazon.com/cloudformation/) 開啟 CloudFormation 主控台。

   1. 刪除`codecatalyst-cfn-stack`。

      刪除堆疊會從 API Gateway 和 Lambda 服務中移除所有教學課程資源。

1. 在 Amazon S3 中清除，如下所示：

   1. 開啟位於 [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/) 的 Amazon S3 主控台。

   1. 選擇 `codecatalyst-cfn-s3-bucket`。

   1. 刪除儲存貯體內容。

   1. 刪除儲存貯體。

1. 在 IAM 中清除，如下所示：

   1. 前往 [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/) 開啟 IAM 主控台。

   1. 刪除`codecatalyst-deploy-policy`。

   1. 刪除`codecatalyst-build-policy`。

   1. 刪除`codecatalyst-stack-policy`。

   1. 刪除`codecatalyst-deploy-role`。

   1. 刪除`codecatalyst-build-role`。

   1. 刪除`codecatalyst-stack-role`。

在本教學課程中，您已了解如何使用 CodeCatalyst 工作流程和部署堆疊動作，將無伺服器應用程式部署為 CloudFormation ** CloudFormation 堆疊**。

# 新增「部署 CloudFormation 堆疊」動作
<a name="deploy-action-cfn-adding"></a>

使用下列指示將**部署 CloudFormation 堆疊**動作新增至您的工作流程。

------
#### [ Visual ]

**使用視覺化編輯器新增「部署 CloudFormation 堆疊」動作**

1. 開啟 CodeCatalyst 主控台，網址為 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/)。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中選擇 **Amazon CodeCatalyst**。

1. 搜尋**部署 CloudFormation 堆疊**動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**部署 CloudFormation 堆疊**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**下載**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 在**輸入**和**組態**索引標籤中，根據您的需求完成欄位。如需每個欄位的說明，請參閱 [「部署 CloudFormation 堆疊」動作 YAML](deploy-action-ref-cfn.md)。此參考提供在 YAML 和視覺化編輯器中顯示的每個欄位 （和對應的 YAML 屬性值） 的詳細資訊。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------
#### [ YAML ]

**使用 YAML 編輯器新增「部署 CloudFormation 堆疊」動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋**部署 CloudFormation 堆疊**動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**部署 CloudFormation 堆疊**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**下載**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 根據您的需求修改 YAML 程式碼中的屬性。中會提供每個可用屬性的說明[「部署 CloudFormation 堆疊」動作 YAML](deploy-action-ref-cfn.md)。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------

# 設定轉返
<a name="deploy-consumption-enable-alarms"></a>

根據預設，如果**部署 CloudFormation 堆疊**動作失敗，將導致 將堆疊 CloudFormation 復原至最後已知的穩定狀態。您可以變更行為，讓回復不僅發生在動作失敗時，也發生在指定的 Amazon CloudWatch 警示發生時。如需有關 CloudWatch 警示的詳細資訊，請參閱 *Amazon CloudWatch 使用者指南*中的[使用 Amazon CloudWatch 警示](https://docs.aws.amazon.com/)。

您也可以變更預設行為，讓 CloudFormation 在動作失敗時不會轉返堆疊。

請使用下列指示來設定轉返。

**注意**  
您無法手動啟動轉返。

------
#### [ Visual ]

**開始之前**

1. 請確定您的[工作流程](workflow.md)包含正常運作的**部署 CloudFormation 堆疊**動作。如需詳細資訊，請參閱[部署 CloudFormation 堆疊](deploy-action-cfn.md)。

1. 在**部署堆疊 CloudFormation **動作的堆疊**角色 - 選用**欄位中指定的角色中，請務必包含 **CloudWatchFullAccess** 許可。如需使用適當許可建立此角色的資訊，請參閱 [步驟 2：建立 AWS 角色](deploy-tut-lambda.md#deploy-tut-lambda-cfn-roles)。

**設定「部署 CloudFormation 堆疊」動作的轉返警示**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 選擇**部署 CloudFormation 堆疊**動作。

1. 在詳細資訊窗格中，選擇**組態**。

1. 在底部，展開**進階**。

1. 在**監控警示 ARNs**下，選擇**新增警示**。

1. 在下列欄位中輸入資訊。
   + **警示 ARN**

     指定 Amazon CloudWatch 警示的 Amazon Resource Name (ARN)，以用作轉返觸發。例如 `arn:aws:cloudwatch::123456789012:alarm/MyAlarm`。您最多可以有五個轉返觸發條件。
**注意**  
如果您指定 CloudWatch 警示 ARN，您還需要設定其他許可，以啟用 動作來存取 CloudWatch。如需詳細資訊，請參閱[設定轉返](#deploy-consumption-enable-alarms)。
   + **監控時間**

     指定 0 到 180 分鐘的時間量，在此期間CloudFormation 會監控指定的警示。監控會在部署所有堆疊資源*之後*開始。如果警示在指定的監控時間內發生，則部署會失敗，CloudFormation 會復原整個堆疊操作。

     預設：0. CloudFormation 只會在部署堆疊資源時監控警示，而不是在部署之後。

------
#### [ YAML ]

**設定「部署 CloudFormation 堆疊」動作的復原觸發**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇包含**部署 CloudFormation 堆疊**動作的工作流程名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在 YAML 程式碼中新增 `monitor-alarm-arns`和 `monitor-timeout-in-minutes` 屬性，以新增轉返觸發條件。如需每個屬性的說明，請參閱 [「部署 CloudFormation 堆疊」動作 YAML](deploy-action-ref-cfn.md)。

1. 在**部署 CloudFormation 堆疊**動作的 `role-arn` 屬性中指定的角色中，請務必包含 **CloudWatchFullAccess** 許可。如需使用適當許可建立此角色的資訊，請參閱 [步驟 2：建立 AWS 角色](deploy-tut-lambda.md#deploy-tut-lambda-cfn-roles)。

------

------
#### [ Visual ]

**關閉「部署 CloudFormation 堆疊」動作的轉返**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇包含**部署 CloudFormation 堆疊**動作的工作流程名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 選擇**部署 CloudFormation 堆疊**動作。

1. 在詳細資訊窗格中，選擇**組態**。

1. 在底部，展開**進階**。

1. 開啟**停用轉返**。

------
#### [ YAML ]

**關閉「部署 CloudFormation 堆疊」動作的轉返**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇包含**部署 CloudFormation 堆疊**動作的工作流程名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在 YAML 程式碼中新增 `disable-rollback: 1` 屬性以停止轉返。如需此屬性的說明，請參閱 [「部署 CloudFormation 堆疊」動作 YAML](deploy-action-ref-cfn.md)。

------

# 「部署 CloudFormation 堆疊」變數
<a name="deploy-action-cfn-variables"></a>

**部署 CloudFormation 堆疊**動作會在執行時間產生並設定下列變數。這些稱為*預先定義的變數*。

如需在工作流程中參考這些變數的資訊，請參閱 [使用預先定義的變數](workflows-using-predefined-variables.md)。


| 金鑰 | 值 | 
| --- | --- | 
|  deployment-platform  |  部署平台的名稱。 硬式編碼為 `AWS:CloudFormation`。  | 
|  region  |  在工作流程執行期間 AWS 區域 部署至 的 區域碼。 範例：`us-west-2`  | 
|  stack-id  |  部署堆疊的 Amazon Resource Name (ARN)。 範例：`arn:aws:cloudformation:us-west-2:111122223333:stack/codecatalyst-cfn-stack/6aad4380-100a-11ec-a10a-03b8a84d40df`  | 

# 「部署 CloudFormation 堆疊」動作 YAML
<a name="deploy-action-ref-cfn"></a>

以下是**部署 CloudFormation 堆疊**動作的 YAML 定義。若要了解如何使用此動作，請參閱 [部署 CloudFormation 堆疊](deploy-action-cfn.md)。

此動作定義以區段的形式存在於更廣泛的工作流程定義檔案中。如需有關此檔案的詳細資訊，請參閱[工作流程 YAML 定義](workflow-reference.md)。

**注意**  
下列大多數 YAML 屬性在視覺化編輯器中都有對應的 UI 元素。若要查詢 UI 元素，請使用 **Ctrl\$1F**。 元素會與其相關聯的 YAML 屬性一起列出。

```
# The workflow definition starts here.
# See 最上層屬性 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  DeployCloudFormationStack:  
    Identifier: aws/cfn-deploy@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: DeployRole
    Inputs:
      Sources:
        - source-name-1
      Artifacts:
        - CloudFormation-artifact
    Configuration:
      name: stack-name
      region: us-west-2
      template: template-path
      role-arn: arn:aws:iam::123456789012:role/StackRole        
      capabilities: CAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND
      parameter-overrides: KeyOne=ValueOne,KeyTwo=ValueTwo | path-to-JSON-file
      no-execute-changeset: 1|0
      fail-on-empty-changeset: 1|0
      disable-rollback: 1|0
      termination-protection: 1|0
      timeout-in-minutes: minutes
      notification-arns: arn:aws:sns:us-east-1:123456789012:MyTopic,arn:aws:sns:us-east-1:123456789012:MyOtherTopic
      monitor-alarm-arns: arn:aws:cloudwatch::123456789012:alarm/MyAlarm,arn:aws:cloudwatch::123456789012:alarm/MyOtherAlarm
      monitor-timeout-in-minutes: minutes       
      tags: '[{"Key":"MyKey1","Value":"MyValue1"},{"Key":"MyKey2","Value":"MyValue2"}]'
```

## DeployCloudFormationStack
<a name="deploy.action.cfn.deploycloudformationstack"></a>

(必要)

指定動作的名稱。工作流程中的所有動作名稱都必須是唯一的。動作名稱僅限於英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (\$1)。不允許空格。您不能使用引號在動作名稱中啟用特殊字元和空格。

預設：`DeployCloudFormationStack_nn`。

對應的 UI：組態索引標籤/**動作顯示名稱**

## Identifier
<a name="deploy.action.cfn.identifier"></a>

(*DeployCloudFormationStack*/**Identifier**)

(必要)

識別 動作。除非您想要變更版本，否則請勿變更此屬性。如需詳細資訊，請參閱[指定要使用的動作版本](workflows-action-versions.md)。

預設：`aws/cfn-deploy@v1`。

對應的 UI：工作流程圖表/DeployCloudFormationStack\$1nn/**aws/cfn-deploy@v1** 標籤

## DependsOn
<a name="deploy.action.cfn.dependson"></a>

(*DeployCloudFormationStack*/**DependsOn**)

(選用)

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

如需 'depends on' 功能的詳細資訊，請參閱 [定序動作](workflows-depends-on.md)。

對應的 UI：輸入索引標籤/**取決於 - 選用**

## Compute
<a name="deploy.action.cfn.computename"></a>

(*DeployCloudFormationStack*/**Compute**)

(選用)

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

對應的 UI：*無*

## Type
<a name="deploy.action.cfn.computetype"></a>

(*DeployCloudFormationStack*/Compute/**Type**)

（如果[Compute](#deploy.action.cfn.computename)包含 則為必要）

運算引擎的類型。您可以使用下列其中一個值：
+ **EC2** （視覺化編輯器） 或 `EC2`(YAML 編輯器）

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

  最佳化動作啟動速度。

如需運算類型的更多相關資訊，請參閱[運算類型](workflows-working-compute.md#compute.types)。

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

## Fleet
<a name="deploy.action.cfn.computefleet"></a>

(*DeployCloudFormationStack*/Compute/**Fleet**)

(選用)

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

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

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

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

## Timeout
<a name="deploy.action.cfn.timeout"></a>

(*DeployCloudFormationStack*/**Timeout**)

(選用)

指定動作在 CodeCatalyst 結束動作之前可執行的時間，以分鐘為單位 (YAML 編輯器） 或小時和分鐘為單位。最小值為 5 分鐘，最大值如 中所述[CodeCatalyst 中工作流程的配額](workflows-quotas.md)。預設逾時與最大逾時相同。

對應的 UI：組態索引標籤/以**分鐘為單位的逾時 - 選用 **

## Environment
<a name="deploy.action.cfn.environment"></a>

(*DeployCloudFormationStack*/**Environment**)

(必要)

指定要與 動作搭配使用的 CodeCatalyst 環境。動作會連線至所選環境中指定的 AWS 帳戶 和選用 Amazon VPC。動作會使用環境中指定的預設 IAM 角色來連線至 AWS 帳戶，並使用 [Amazon VPC 連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)中指定的 IAM 角色來連線至 Amazon VPC。

**注意**  
如果預設 IAM 角色沒有 動作所需的許可，您可以將 動作設定為使用不同的角色。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

如需環境的詳細資訊，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)和 [建立環境](deploy-environments-creating-environment.md)。

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

## Name
<a name="deploy.action.cfn.environment.name"></a>

(*DeployCloudFormationStack*/Environment/**Name**)

（如果[Environment](#deploy.action.cfn.environment)包含 則為必要）

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

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

## Connections
<a name="deploy.action.cfn.environment.connections"></a>

(*DeployCloudFormationStack*/Environment/**Connections**)

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

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

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

如需帳戶連線的詳細資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。如需將帳戶連線新增至環境的相關資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Name
<a name="deploy.action.cfn.environment.connections.name"></a>

(*DeployCloudFormationStack*/Environment/Connections/**Name**)

（如果[Connections](#deploy.action.cfn.environment.connections)包含 則為必要）

指定帳戶連線的名稱。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Role
<a name="deploy.action.cfn.environment.connections.role"></a>

(*DeployCloudFormationStack*/Environment/Connections/**Role**)

（如果[Connections](#deploy.action.cfn.environment.connections)包含 則為必要）

指定**部署 CloudFormation 堆疊**動作用來存取 AWS 和 CloudFormation 服務的 IAM 角色名稱。請確定您已[將角色新增至 CodeCatalyst 空間](ipa-connect-account-addroles.md)，且該角色包含下列政策。

如果您未指定 IAM 角色，則動作會使用 CodeCatalyst 主控台中[環境中](deploy-environments.md)列出的預設 IAM 角色。如果您在環境中使用預設角色，請確定其具有下列政策。
+ 下列許可政策：
**警告**  
將許可限制為下列政策中顯示的許可。使用具有更廣泛許可的角色可能會帶來安全風險。
**注意**  
第一次使用角色時，請在資源政策陳述式中使用下列萬用字元，然後在可用的資源名稱縮小政策範圍。  

  ```
  "Resource": "*"
  ```
+ 下列自訂信任政策：

**注意**  
如有需要，您可以使用 `CodeCatalystWorkflowDevelopmentRole-spaceName`角色搭配此動作。如需有關此角色的詳細資訊，請參閱 [為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有可能造成安全風險的完整存取許可。我們建議您只在安全性較少的教學課程和案例中使用此角色。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**Role**

## Inputs
<a name="deploy.action.cfn.inputs"></a>

(*DeployCloudFormationStack*/**Inputs**)

(選用)

`Inputs` 區段定義工作流程執行期間 `DeployCloudFormationStack`所需的資料。

**注意**  
每個**部署 CloudFormation 堆疊**動作最多允許四個輸入 （一個來源和三個成品）。

如果您需要參考位於不同輸入中的檔案 （例如來源和成品），則來源輸入是主要輸入，而成品是次要輸入。對次要輸入中檔案的參考需要特殊的字首，才能將其從主要輸入中消除。如需詳細資訊，請參閱[範例：參考多個成品中的檔案](workflows-working-artifacts-ex.md#workflows-working-artifacts-ex-ref-file)。

對應的 UI：**輸入**索引標籤

## Sources
<a name="deploy.action.cfn.inputs.sources"></a>

(*DeployCloudFormationStack*/Inputs/**Sources**)

（如果您的 CloudFormation 或 AWS SAM 範本存放在來源儲存庫中，則為必要項目）

如果您的 CloudFormation 或 AWS SAM 範本存放在來源儲存庫中，請指定該來源儲存庫的標籤。目前，唯一支援的標籤是 `WorkflowSource`。

如果您的 CloudFormation 或 AWS SAM 範本不包含在來源儲存庫中，則必須位於另一個動作所產生的成品中，或位於 Amazon S3 儲存貯體中。

如需來源的詳細資訊，請參閱 [將來源儲存庫連線至工作流程](workflows-sources.md)。

對應的 UI：輸入索引標籤/**來源 - 選用**

## Artifacts - input
<a name="deploy.action.cfn.inputs.artifacts"></a>

(*DeployCloudFormationStack*/Inputs/**Artifacts**)

（如果您的 CloudFormation 或 AWS SAM 範本存放在先前動作的[輸出成品](workflows-working-artifacts-output.md)中，則為必要項目）

如果您想要部署的 CloudFormation 或 AWS SAM 範本包含在先前動作產生的成品中，請在此處指定該成品。如果您的 CloudFormation 範本不包含在成品中，則必須位於來源儲存庫或 Amazon S3 儲存貯體中。

如需成品的詳細資訊，包括範例，請參閱 [在動作之間共用成品和檔案](workflows-working-artifacts.md)。

對應的 UI：組態索引標籤/**文章 - 選用**

## Configuration
<a name="deploy.action.cfn.configuration"></a>

(*DeployCloudFormationStack*/**Configuration**)

(必要)

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

對應的 UI：**組態**索引標籤

## name
<a name="deploy.action.cfn.stackname"></a>

(*DeployCloudFormationStack*/Configuration/**name**)

(必要)

指定部署堆疊動作建立或更新的 CloudFormation 堆疊名稱。 ** CloudFormation **

對應的 UI：組態索引標籤/**堆疊名稱**

## region
<a name="deploy.action.cfn.stackregion"></a>

(*DeployCloudFormationStack*/Configuration/**region**)

(必要)

指定要部署堆疊的 AWS 區域 。如需區域代碼清單，請參閱[區域端點](https://docs.aws.amazon.com/general/latest/gr/rande.html#region-names-codes)。

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

## template
<a name="deploy.action.cfn.templatepath"></a>

(*DeployCloudFormationStack*/Configuration/**template**)

(必要)

指定 CloudFormation 或 AWS SAM 範本檔案的名稱和路徑。範本可以是 JSON 或 YAML 格式，並且可以位於來源儲存庫、先前動作的成品或 Amazon S3 儲存貯體中。如果範本檔案位於來源儲存庫或成品中，則路徑會相對於來源或成品根目錄。如果範本位於 Amazon S3 儲存貯體中，則路徑是範本的**物件 URL** 值。

範例：

`./MyFolder/MyTemplate.json`

`MyFolder/MyTemplate.yml`

`https://MyBucket.s3.us-west-2.amazonaws.com/MyTemplate.yml`

**注意**  
您可能需要將字首新增至範本的檔案路徑，以指出要尋找的成品或來源。如需詳細資訊，請參閱[參考來源儲存庫檔案](workflows-sources-reference-files.md)及[參考成品中的檔案](workflows-working-artifacts-refer-files.md)。

對應的 UI：組態索引標籤/**範本**

## role-arn
<a name="deploy.action.cfn.stackrolearn"></a>

(*DeployCloudFormationStack*/Configuration/**role-arn**)

(必要)

指定堆疊角色的 Amazon Resource Name (ARN)。CloudFormation 使用此角色來存取和修改堆疊中的資源。例如：`arn:aws:iam::123456789012:role/StackRole`。

請確定堆疊角色包含：
+ 一或多個許可政策。這些政策取決於您在堆疊中擁有的資源。例如，如果您的堆疊包含 AWS Lambda 函數，您需要新增授予 Lambda 存取權的許可。如果您遵循 中所述的教學課程[教學課程：部署無伺服器應用程式](deploy-tut-lambda.md)，它包含標題為 的程序，[建立堆疊角色](deploy-tut-lambda.md#deploy-tut-lambda-cfn-roles-stack)其中列出當您部署典型的無伺服器應用程式堆疊時堆疊角色所需的許可。
**警告**  
將許可限制為 CloudFormation 服務存取堆疊中資源所需的許可。使用具有更廣泛許可的角色可能會帶來安全風險。
+ 下列信任政策：

------
#### [ JSON ]

****  

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

------

或者，將此角色與您的帳戶連線建立關聯。若要進一步了解如何將 IAM 角色與帳戶連線建立關聯，請參閱 [新增 IAM 角色至帳戶連線](ipa-connect-account-addroles.md)。如果您未將堆疊角色與帳戶連線建立關聯，堆疊角色就不會出現在視覺化編輯器的**堆疊角色**下拉式清單中；不過，仍然可以使用 YAML 編輯器在 `role-arn` 欄位中指定角色 ARN。

**注意**  
如有需要，您可以使用 `CodeCatalystWorkflowDevelopmentRole-spaceName`角色搭配此動作。如需有關此角色的詳細資訊，請參閱 [為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有可能造成安全風險的完整存取許可。我們建議您只在安全性較少的教學課程和案例中使用此角色。

對應的 UI：組態索引標籤/**堆疊角色 - 選用**

## capabilities
<a name="deploy.action.cfn.capabilities"></a>

(*DeployCloudFormationStack*/Configuration/**capabilities**)

(必要)

指定允許 CloudFormation 建立特定堆疊所需的 IAM 功能清單。在大多數情況下，您可以使用預設值 `capabilities` 來離開 `CAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND`。

如果您在**部署 CloudFormation 堆疊**動作的日誌`##[error] requires capabilities: [capability-name]`中看到 ，請參閱 以取得如何修正問題[如何修正 IAM 功能錯誤？](troubleshooting-workflows.md#troubleshooting-workflows-capabilities)的相關資訊。

如需 IAM 功能的詳細資訊，請參閱《[IAM 使用者指南》中的在 CloudFormation 範本中確認 IAM 資源](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities)。 **

對應的 UI：組態索引標籤/進階/**功能**

## parameter-overrides
<a name="deploy.action.cfn.parameter.overrides"></a>

(*DeployCloudFormationStack*/Configuration/**parameter-overrides**)

(選用)

在 CloudFormation 或 AWS SAM 範本中指定沒有預設值的參數，或您要為其指定非預設值的參數。如需參數的詳細資訊，請參閱* AWS CloudFormation 《 使用者指南*》中的[參數](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)。

`parameter-overrides` 屬性接受：
+ 包含參數和值的 JSON 檔案。
+ 參數和值的逗號分隔清單。

**指定 JSON 檔案**

1. 請確定 JSON 檔案使用以下其中一個語法：

   ```
   {
     "Parameters": {
       "Param1": "Value1",
       "Param2": "Value2",
       ...
     }
   }
   ```

   或者...

   ```
   [
     {
        "ParameterKey": "Param1",
        "ParameterValue": "Value1"
     },
     ...
   ]
   ```

   （還有其他語法，但撰寫時 CodeCatalyst 不支援這些語法。) 如需在 JSON 檔案中指定 CloudFormation 參數的詳細資訊，請參閱《 *AWS CLI 命令參考*》中的[支援的 JSON 語法](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/deploy/index.html#supported-json-syntax)。

1. 使用下列其中一種格式指定 JSON 檔案的路徑：
   + 如果您的 JSON 檔案位於先前動作的輸出成品中，請使用：

     `file:///artifacts/current-action-name/output-artifact-name/path-to-json-file`

     如需詳細資訊，請參閱**範例 1**。
   + 如果您的 JSON 檔案位於來源儲存庫中，請使用：

     `file:///sources/WorkflowSource/path-to-json-file`

     如需詳細資訊，請參閱**範例 2**。

     **範例 1** – JSON 檔案位於輸出成品中

     ```
     ##My workflow YAML
     ...
     Actions:
       MyBuildAction:
         Identifier: aws/build@v1
         Outputs:
           Artifacts:
             - Name: ParamArtifact
               Files:
                 - params.json
         Configuration:
         ...
       MyDeployCFNStackAction:
         Identifier: aws/cfn-deploy@v1
         Configuration:
           parameter-overrides: file:///artifacts/MyDeployCFNStackAction/ParamArtifact/params.json
     ```

     **範例 2** – JSON 檔案位於名為 的資料夾中的來源儲存庫中 `my/folder`

     ```
     ##My workflow YAML
     ...
     Actions:
       MyDeployCloudFormationStack:
         Identifier: aws/cfn-deploy@v1
         Inputs:
           Sources:
             - WorkflowSource
         Configuration:
           parameter-overrides: file:///sources/WorkflowSource/my/folder/params.json
     ```

**使用逗號分隔的參數清單**
+ 使用下列格式在 `parameter-overrides` 屬性中新增參數名稱/值對：

  `param-1=value-1,param-2=value-2`

  例如，假設下列 CloudFormation 範本：

  ```
  ##My CloudFormation template
  
  Description: My CloudFormation template
  
  Parameters:
    InstanceType:
      Description: Defines the Amazon EC2 compute for the production server.
      Type: String
      Default: t2.micro
      AllowedValues:
        - t2.micro
        - t2.small
        - t3.medium
      
  Resources:
  ...
  ```

  ...您可以設定 `parameter-overrides` 屬性，如下所示：

  ```
  ##My workflow YAML
  ...
  Actions:
  ...
    DeployCloudFormationStack:
      Identifier: aws/cfn-deploy@v1
      Configuration:
        parameter-overrides: InstanceType=t3.medium,UseVPC=true
  ```
**注意**  
您可以使用 `undefined`做為值，指定沒有對應值的參數名稱。例如：  
`parameter-overrides: MyParameter=undefined`  
 效果是，在堆疊更新期間，CloudFormation 會使用指定參數名稱的現有參數值。

對應的 UI：
+ 組態索引標籤/進階/**參數覆寫**
+ 組態tab/Advanced/Parameter覆寫/**使用檔案指定覆寫**
+ 組態tab/Advanced/Parameter覆寫/**使用值集指定覆寫**

## no-execute-changeset
<a name="deploy.action.cfn.noexecutechangeset"></a>

(*DeployCloudFormationStack*/Configuration/**no-execute-changeset**)

(選用)

指定您是否希望 CodeCatalyst 建立 CloudFormation 變更集，然後在執行之前停止。這可讓您在 CloudFormation 主控台中檢閱變更集。如果您判斷變更集看起來不錯，請停用此選項，然後重新執行工作流程，讓 CodeCatalyst 可以在不停止的情況下建立和執行變更集。預設值是在不停止的情況下建立和執行變更集。如需詳細資訊，請參閱《 *AWS CLI 命令參考*》中的 CloudFormation [部署](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/index.html)參數。如需檢視變更集的詳細資訊，請參閱*AWS CloudFormation 《 使用者指南*》中的[檢視變更集](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets-view.html)。

對應的 UI：組態索引標籤/進階/**未執行變更集**

## fail-on-empty-changeset
<a name="deploy.action.cfn.failonemptychangeset"></a>

(*DeployCloudFormationStack*/Configuration/**fail-on-empty-changeset**)

(選用)

如果 CloudFormation 變更集為空，請指定您是否希望 CodeCatalyst 失敗**部署 CloudFormation 堆疊**動作。（如果變更集是空的，表示在最新的部署期間不會對堆疊進行任何變更。) 預設值是在變更集為空時允許動作繼續，即使堆疊未更新，也會傳回`UPDATE_COMPLETE`訊息。

如需此設定的詳細資訊，請參閱《 *AWS CLI 命令參考*》中的 CloudFormation [部署](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/index.html)參數。如需變更集的詳細資訊，請參閱*AWS CloudFormation 《 使用者指南*》中的[使用變更集更新堆疊](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html)。

對應的 UI：**空白變更集上的組態索引標籤/進階/失敗**

## disable-rollback
<a name="deploy.action.cfn.disablerollback"></a>

(*DeployCloudFormationStack*/Configuration/**disable-rollback**)

(選用)

指定您是否希望 CodeCatalyst 在堆疊部署失敗時復原堆疊部署。轉返會將堆疊傳回至上次已知的穩定狀態。預設為啟用轉返。如需此設定的詳細資訊，請參閱《 *AWS CLI 命令參考*》中的 CloudFormation [部署](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/index.html)參數。

如需**部署 CloudFormation 堆疊**動作如何處理轉返的詳細資訊，請參閱 [設定轉返](deploy-consumption-enable-alarms.md)。

如需復原堆疊的詳細資訊，請參閱*AWS CloudFormation 《 使用者指南*》中的[堆疊失敗選項](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-failure-options.html)。

對應的 UI：組態索引標籤/進階/**停用復原**

## termination-protection
<a name="deploy.action.cfn.terminationprotection"></a>

(*DeployCloudFormationStack*/Configuration/**termination-protection**)

(選用)

指定您是否希望**部署 CloudFormation 堆疊**為其正在部署的堆疊新增終止保護。如果使用者嘗試刪除啟用終止保護的堆疊，則刪除會失敗，且堆疊及其狀態保持不變。預設為停用終止保護。如需詳細資訊，請參閱*AWS CloudFormation 《 使用者指南*》中的[防止堆疊遭到刪除](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html)。

對應的 UI：組態索引標籤/進階/**終止保護**

## timeout-in-minutes
<a name="deploy.action.cfn.timeoutinminutes"></a>

(*DeployCloudFormationStack*/Configuration/**timeout-in-minutes**)

(選用)

指定 CloudFormation 在逾時堆疊建立操作並將堆疊狀態設定為 之前應分配的時間量，以分鐘為單位`CREATE_FAILED`。如果 CloudFormation 無法在分配的時間內建立整個堆疊，操作便會因為逾時而失敗，並復原堆疊。

依預設，堆疊建立沒有逾時。不過，個別資源可能會因其實作的服務性質而有自己的逾時。例如，如果堆疊中的個別資源逾時，堆疊建立也會逾時，即使尚未達到您指定的堆疊建立逾時。

對應的 UI：組態索引標籤/進階/**CloudFormation 逾時**

## notification-arns
<a name="deploy.action.cfn.notificationarns"></a>

(*DeployCloudFormationStack*/Configuration/**notification-arns**)

(選用)

指定您希望 CodeCatalyst 傳送通知訊息的 Amazon SNS 主題 ARN。例如 `arn:aws:sns:us-east-1:111222333:MyTopic`。**部署 CloudFormation 堆疊**動作執行時，CodeCatalyst 會與 CloudFormation 協調，針對堆疊建立或更新程序期間發生的每個 CloudFormation 事件傳送一個通知。（事件會顯示在 CloudFormation 主控台的堆疊**事件**索引標籤中。) 您最多可以指定五個主題。如需詳細資訊，請參閱[什麼是 Amazon SNS？](https://docs.aws.amazon.com/sns/latest/dg/welcome.html)。

對應的 UI：組態索引標籤/進階/**通知 ARNs**

## monitor-alarm-arns
<a name="deploy.action.cfn.monitoralarmarns"></a>

(*DeployCloudFormationStack*/Configuration/**monitor-alarm-arns**)

(選用)

指定 Amazon CloudWatch 警示的 Amazon Resource Name (ARN)，以用作轉返觸發。例如 `arn:aws:cloudwatch::123456789012:alarm/MyAlarm`。您最多可以有五個轉返觸發。

**注意**  
如果您指定 CloudWatch 警示 ARN，您還需要設定其他許可，以啟用 動作來存取 CloudWatch。如需詳細資訊，請參閱[設定轉返](deploy-consumption-enable-alarms.md)。

對應的 UI：組態索引標籤/進階/**監控警示 ARNs **

## monitor-timeout-in-minutes
<a name="deploy.action.cfn.monitortimeinminutes"></a>

(*DeployCloudFormationStack*/Configuration/**monitor-timeout-in-minutes**)

(選用)

指定時間量，從 0 到 180 分鐘，在此期間CloudFormation 會監控指定的警示。部署所有堆疊資源*之後*，監控就會開始。如果警示在指定的監控時間內發生，則部署會失敗，CloudFormation 會復原整個堆疊操作。

預設：0. CloudFormation 只會在部署堆疊資源時監控警示，而不是在部署之後。

對應的 UI：組態索引標籤/進階/**監控時間**

## tags
<a name="deploy.action.cfn.tags"></a>

(*DeployCloudFormationStack*/Configuration/**tags**)

(選用)

指定要連接到 CloudFormation 堆疊的標籤。標籤是任意索引鍵/值組，可用於識別堆疊，例如成本分配。如需有關標籤定義及標籤使用方式的詳細資訊，請參閱《Amazon EC2 使用者指南》中的[標記您的資源](https://docs.aws.amazon.com/)。如需在 CloudFormation 中標記的詳細資訊，請參閱*AWS CloudFormation 《 使用者指南*》中的[設定 CloudFormation 堆疊選項](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html)。

金鑰可以有英數字元或空格，且最多可有 127 個字元。值可以有英數字元或空格，且最多可有 255 個字元。

您最多可以為每個堆疊新增 50 個唯一的標籤。

對應的 UI：組態索引標籤/進階/**標籤**

# 使用工作流程部署 AWS CDK 應用程式
<a name="cdk-dep-action"></a>

本節說明如何使用工作流程將 AWS Cloud Development Kit (AWS CDK) 應用程式部署到您的 AWS 帳戶。若要達成此目的，您必須將**AWS CDK 部署**動作新增至工作流程。**AWS CDK 部署**動作會合成您的 AWS Cloud Development Kit (AWS CDK) 應用程式並將其部署到其中 AWS。如果您的應用程式已存在於 中 AWS，則動作會視需要更新它。

如需使用 撰寫應用程式的一般資訊 AWS CDK，請參閱[什麼是 AWS CDK？](https://docs.aws.amazon.com/cdk/v2/guide/home.html) 《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*》中的 。

**Topics**
+ [何時使用 'AWS CDK deploy' 動作](#cdk-dep-action-when-to-use)
+ [「AWS CDK 部署」動作的運作方式](#cdk-dep-action-how-it-works)
+ [「AWS CDK 部署」動作使用的 CDK CLI 版本](#cdk-dep-action-cdk-version)
+ [「AWS CDK 部署」動作使用的執行期映像](#cdk-dep-action-runtime)
+ [動作可以部署多少個堆疊？](#cdk-dep-action-how-many-stacks)
+ [範例：部署 AWS CDK 應用程式](cdk-dep-action-example-workflow.md)
+ [新增「AWS CDK 部署」動作](cdk-dep-action-add.md)
+ [「AWS CDK 部署」變數](cdk-dep-action-variables.md)
+ [「AWS CDK 部署」動作 YAML](cdk-dep-action-ref.md)

## 何時使用 'AWS CDK deploy' 動作
<a name="cdk-dep-action-when-to-use"></a>

如果您已使用 開發應用程式 AWS CDK，且現在想要將其自動部署為自動化持續整合和交付 (CI/CD) 工作流程的一部分，請使用此動作。例如，您可能想要在有人合併與 AWS CDK 應用程式來源相關的提取請求時自動部署 AWS CDK 應用程式。

## 「AWS CDK 部署」動作的運作方式
<a name="cdk-dep-action-how-it-works"></a>

**AWS CDK 部署**的運作方式如下：

1. 在執行時間，如果您指定 動作的 1.0.12 版或更早版本，動作會將最新的 CDK CLI （也稱為 AWS CDK Tookit) 下載至 CodeCatalyst [執行時間環境映像](#cdk-dep-action-runtime)。

   如果您指定 1.0.13 版或更新版本，動作會隨附[特定版本的](#cdk-dep-action-cdk-version) CDK CLI，因此不會進行下載。

1. 動作會使用 CDK CLI 來執行 `cdk deploy`命令。此命令會合成您的 AWS CDK 應用程式並將其部署到其中 AWS。如需此命令的詳細資訊，請參閱《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*》中的 [AWS CDK Toolkit (cdk 命令）](https://docs.aws.amazon.com/cli/latest/reference/s3/sync.html) 主題。

## 「AWS CDK 部署」動作使用的 CDK CLI 版本
<a name="cdk-dep-action-cdk-version"></a>

下表顯示部署**AWS CDK **動作不同版本預設使用的 CDK CLI 版本。

**注意**  
您可能可以覆寫預設值。如需詳細資訊，請參閱 [「AWS CDK 部署」動作 YAML](cdk-dep-action-ref.md) 中的 [CdkCliVersion](cdk-dep-action-ref.md#cdk.dep.cdk.cli.version)。


| 「AWS CDK 部署」動作版本 | AWS CDK CLI 版本 | 
| --- | --- | 
|  1.0.0 – 1.0.12  |  最新  | 
|  1.0.13 或更新版本  |  2.99.1  | 

## 「AWS CDK 部署」動作使用的執行期映像
<a name="cdk-dep-action-runtime"></a>

下表顯示 CodeCatalyst 用來執行不同版本**AWS CDK 部署**動作的執行期環境映像。影像包含不同的預先安裝工具集。如需詳細資訊，請參閱[作用中映像](build-images.md#build-curated-images)。

**注意**  
我們建議您將**AWS CDK 部署**動作升級至 2.x 版，以利用 2024 年 3 月映像中可用的最新工具。若要升級動作，`aws/cdk-deploy@v2`請在工作流程定義檔案中將其`Identifier`屬性設定為 。如需詳細資訊，請參閱[「AWS CDK 部署」動作 YAML](cdk-dep-action-ref.md)。


| 「AWS CDK 部署」動作版本 | 執行期環境映像 | 
| --- | --- | 
|  1.x  |  2022 年 11 月影像  | 
|  2.x  |  2024 年 3 月影像  | 

## 動作可以部署多少個堆疊？
<a name="cdk-dep-action-how-many-stacks"></a>

**AWS CDK 部署**只能部署單一堆疊。如果您的 AWS CDK 應用程式包含多個堆疊，您必須建立具有巢狀堆疊的父堆疊，並使用此動作部署父堆疊。

# 範例：部署 AWS CDK 應用程式
<a name="cdk-dep-action-example-workflow"></a>

下列範例工作流程包含**AWS CDK 部署**動作，以及**AWS CDK 引導**操作。工作流程包含下列依順序執行的建置區塊：
+ **觸發**條件 – 當您將變更推送至來源儲存庫時，此觸發條件會自動啟動工作流程執行。此儲存庫包含您的 AWS CDK 應用程式。關於觸發條件的詳細資訊，請參閱 [使用觸發程序自動啟動工作流程執行](workflows-add-trigger.md)。
+ **AWS CDK 引導**操作 (`CDKBootstrap`) – 在觸發時，該動作會將`CDKToolkit`引導堆疊部署到其中 AWS。如果`CDKToolkit`堆疊已存在於環境中，將會視需要升級；否則不會發生任何情況，且動作會標示為成功。
+ **AWS CDK 部署**動作 (`AWS CDK Deploy`) – **AWS CDK 引導**動作完成後，**AWS CDK 部署**動作會將您的 AWS CDK 應用程式程式碼合成至 CloudFormation 範本，並將範本中定義的堆疊部署至其中 AWS。

**注意**  
下列工作流程範例僅供說明之用，如果沒有其他組態，將無法運作。

**注意**  
在後續的 YAML 程式碼中，您可以視需要省略這些`Connections:`區段。如果您省略這些區段，您必須確保環境中**預設 IAM 角色**欄位中指定的角色包含**AWS CDK 引導**和**AWS CDK 部署**動作所需的許可和信任政策。如需使用預設 IAM 角色設定環境的詳細資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。如需**AWS CDK 引導**和**AWS CDK 部署**動作所需許可和信任政策的詳細資訊，請參閱 [「AWS CDK 引導」動作 YAML](cdk-boot-action-ref.md)和 中的 `Role` 屬性描述[「AWS CDK 部署」動作 YAML](cdk-dep-action-ref.md)。

```
Name: codecatalyst-cdk-deploy-workflow
SchemaVersion: 1.0

Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  CDKBootstrap:
    Identifier: aws/cdk-bootstrap@v2
    Inputs:
      Sources:
        - WorkflowSource
    Environment:
      Name: codecatalyst-cdk-deploy-environment
      Connections:
        - Name: codecatalyst-account-connection
          Role: codecatalyst-cdk-bootstrap-role
    Configuration:
      Region: us-west-2
        
  CDKDeploy:
    Identifier: aws/cdk-deploy@v2
    DependsOn: 
      - CDKBootstrap
    Environment:
      Name: codecatalyst-cdk-deploy-environment
      Connections:
        - Name: codecatalyst-account-connection
          Role: codecatalyst-cdk-deploy-role
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      StackName: my-app-stack
      Region: us-west-2
```

# 新增「AWS CDK 部署」動作
<a name="cdk-dep-action-add"></a>

 使用下列指示將**AWS CDK 部署**動作新增至您的工作流程。

**開始之前**

在您可以將**AWS CDK 部署**動作新增至工作流程之前，請先完成下列任務：

1. **準備好 AWS CDK 應用程式**。您可以使用 AWS CDK v1 或 v2，以 支援的任何程式設計語言撰寫 AWS CDK 應用程式 AWS CDK。確保您的 AWS CDK 應用程式檔案可用於：
   + CodeCatalyst [來源儲存庫](source.md)，或 
   + 由另一個工作流程動作產生的 CodeCatalyst [輸出成品](workflows-working-artifacts.md) 

1. **引導您的 AWS 環境**。若要引導，您可以：
   + 使用《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*》中[如何引導](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html#bootstrapping-howto)所述的其中一種方法。
   + 使用**AWS CDK 引導**操作。您可以在與**AWS CDK 部署**相同的工作流程中新增此動作，或在不同的工作流程中新增此動作。只要確定引導操作在執行**AWS CDK 部署**動作之前至少執行一次，以便有必要的資源。如需**AWS CDK 引導**操作的詳細資訊，請參閱 [使用工作流程引導 AWS CDK 應用程式](cdk-boot-action.md)。

     如需引導的詳細資訊，請參閱《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*》中的[引導](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html)。

------
#### [ Visual ]

**使用視覺化編輯器新增「AWS CDK 部署」動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋**AWS CDK 部署**動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**AWS CDK 部署**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**下載**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 在**輸入**和**組態**索引標籤中，根據您的需求完成欄位。如需每個欄位的說明，請參閱 [「AWS CDK 部署」動作 YAML](cdk-dep-action-ref.md)。此參考提供在 YAML 和視覺化編輯器中顯示的每個欄位 （和對應的 YAML 屬性值） 的詳細資訊。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。
**注意**  
如果您的**AWS CDK 部署**動作失敗並發生錯誤`npm install`，請參閱 以取得如何修正錯誤[如何修正「npm 安裝」錯誤？](troubleshooting-workflows.md#troubleshooting-workflows-npm)的資訊。

------
#### [ YAML ]

**使用 YAML 編輯器新增「AWS CDK 部署」動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋**AWS CDK 部署**動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**AWS CDK 部署**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**下載**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 根據您的需求修改 YAML 程式碼中的屬性。中提供了每個可用屬性的說明[「AWS CDK 部署」動作 YAML](cdk-dep-action-ref.md)。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。
**注意**  
如果您的**AWS CDK 部署**動作失敗並發生錯誤`npm install`，請參閱 以取得如何修正錯誤[如何修正「npm 安裝」錯誤？](troubleshooting-workflows.md#troubleshooting-workflows-npm)的資訊。

------

# 「AWS CDK 部署」變數
<a name="cdk-dep-action-variables"></a>

**AWS CDK 部署**動作會在執行時間產生並設定下列變數。這些稱為*預先定義的變數*。

如需在工作流程中參考這些變數的資訊，請參閱 [使用預先定義的變數](workflows-using-predefined-variables.md)。


| 金鑰 | 值 | 
| --- | --- | 
|  stack-id  |  在工作流程執行期間部署至 之 AWS CDK 應用程式堆疊的 Amazon Resource Name (ARN)。 範例：`arn:aws:cloudformation:us-west-2:111122223333:stack/codecatalyst-cdk-app-stack/6aad4380-100a-11ec-a10a-03b8a84d40df`  | 
|  deployment-platform  |  部署平台的名稱。 硬式編碼為 `AWS:CloudFormation`。  | 
|  region  |  在工作流程執行期間 AWS 區域 部署至 的 區域碼。 範例：`us-west-2`  | 
|  SKIP-DEPLOYMENT  |  值 `true`表示在工作流程執行期間略過 AWS CDK 應用程式堆疊的部署。如果堆疊自上次部署以來沒有變更，則會略過堆疊部署。 只有在其值為 時，才會產生此變數`true`。 硬式編碼為 `true`。  | 
|  *CloudFormation 變數*  |  除了產生先前列出的變數之外，**AWS CDK 部署**動作還會將 *CloudFormation* 輸出變數公開為*工作流程*變數，以供後續工作流程動作使用。根據預設， 動作只會公開其找到的前四個 （或更少） CloudFormation 變數。若要判斷哪些公開，請執行一次**AWS CDK 部署**動作，然後查看執行詳細資訊頁面的**變數**索引標籤。如果變數索引標籤上列出的變數不是您想要的變數，您可以使用 `CfnOutputVariables` YAML 屬性來設定不同的**變數**。如需詳細資訊，請參閱 中的 [CfnOutputVariables](cdk-dep-action-ref.md#cdk.dep.cfn.out) 屬性描述[「AWS CDK 部署」動作 YAML](cdk-dep-action-ref.md)。  | 

# 「AWS CDK 部署」動作 YAML
<a name="cdk-dep-action-ref"></a>

以下是**AWS CDK 部署**動作的 YAML 定義。若要了解如何使用此動作，請參閱 [使用工作流程部署 AWS CDK 應用程式](cdk-dep-action.md)。

此動作定義以區段的形式存在於更廣泛的工作流程定義檔案中。如需有關此檔案的詳細資訊，請參閱[工作流程 YAML 定義](workflow-reference.md)。

**注意**  
下列大多數 YAML 屬性在視覺化編輯器中都有對應的 UI 元素。若要查詢 UI 元素，請使用 **Ctrl\$1F**。 元素將與其相關聯的 YAML 屬性一起列出。

```
# The workflow definition starts here.
# See 最上層屬性 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.   
  CDKDeploy\$1nn: 
    Identifier: aws/cdk-deploy@v2
    DependsOn:
      - CDKBootstrap
    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_artifact
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      StackName: my-cdk-stack
      Region: us-west-2
      Tags: '{"key1": "value1", "key2": "value2"}'
      Context: '{"key1": "value1", "key2": "value2"}'
      CdkCliVersion: version
      CdkRootPath: directory-containing-cdk.json-file
      CfnOutputVariables: '["CnfOutputKey1","CfnOutputKey2","CfnOutputKey3"]'
      CloudAssemblyRootPath: path-to-cdk.out
```

## CDKDeploy
<a name="cdk.dep.name"></a>

(必要)

指定動作的名稱。工作流程中的所有動作名稱都必須是唯一的。動作名稱僅限於英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (\$1)。不允許空格。您無法使用引號在動作名稱中啟用特殊字元和空格。

預設：`CDKDeploy_nn`。

對應的 UI：組態索引標籤/**動作名稱**

## Identifier
<a name="cdk.dep.identifier"></a>

(*CDKDeploy*/**Identifier**)

(必要)

識別 動作。除非您想要變更版本，否則請勿變更此屬性。如需詳細資訊，請參閱[指定要使用的動作版本](workflows-action-versions.md)。

**注意**  
指定 `aws/cdk-deploy@v2`會導致 動作在 [2024 年 3 月映像](build-images.md#build.default-image)上執行，其中包括較新的工具，例如 Node.js 18。指定 `aws/cdk-deploy@v1`會導致 動作在 [2022 年 11 月映像](build-images.md#build.previous-image)上執行，其中包含舊版工具，例如 Node.js 16。

預設：`aws/cdk-deploy@v2`。

對應的 UI：工作流程圖表/CDKDeploy\$1nn/**aws/cdk-deploy@v2** 標籤

## DependsOn
<a name="cdk.dep.dependson"></a>

(*CDKDeploy*/**DependsOn**)

(選用)

指定必須成功執行的動作或動作群組，才能執行**AWS CDK 部署**動作。建議您在 `DependsOn` 屬性中指定**AWS CDK 引導**操作，如下所示：

```
CDKDeploy:
  Identifier: aws/cdk-deploy@v2
  DependsOn:
    - CDKBootstrap
```

**注意**  
[引導](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html)是部署 AWS CDK 應用程式的強制性先決條件。如果您未在工作流程中包含**AWS CDK 引導**操作，則必須先找到另一種方法來部署 AWS CDK 引導堆疊，才能執行**AWS CDK 部署**動作。如需詳細資訊，請參閱 [使用工作流程部署 AWS CDK 應用程式](cdk-dep-action.md) 中的 [新增「AWS CDK 部署」動作](cdk-dep-action-add.md)。

如需 'depends on' 功能的詳細資訊，請參閱 [定序動作](workflows-depends-on.md)。

對應的 UI：輸入索引標籤/**取決於 - 選用**

## Compute
<a name="cdk.dep.computename"></a>

(*CDKDeploy*/**Compute**)

(選用)

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

對應的 UI：*無*

## Type
<a name="cdk.dep.computetype"></a>

(*CDKDeploy*/Compute/**Type**)

（如果[Compute](#cdk.dep.computename)包含 則為必要）

運算引擎的類型。您可以使用下列其中一個值：
+ **EC2** （視覺化編輯器） 或 `EC2`(YAML 編輯器）

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

  最佳化動作啟動速度。

如需運算類型的更多相關資訊，請參閱[運算類型](workflows-working-compute.md#compute.types)。

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

## Fleet
<a name="cdk.dep.computefleet"></a>

(*CDKDeploy*/Compute/**Fleet**)

(選用)

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

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

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

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

## Timeout
<a name="cdk.dep.timeout"></a>

(*CDKDeploy*/**Timeout**)

(必要)

指定動作在 CodeCatalyst 結束動作之前可執行的時間，以分鐘為單位 (YAML 編輯器） 或小時和分鐘為單位。最小值為 5 分鐘，最大值如 中所述[CodeCatalyst 中工作流程的配額](workflows-quotas.md)。預設逾時與最大逾時相同。

對應的 UI：組態索引標籤/**逾時 - 選用 **

## Inputs
<a name="cdk.dep.inputs"></a>

(*CDKDeploy*/**Inputs**)

(選用)

`Inputs` 區段定義工作流程執行期間 `CDKDeploy`所需的資料。

**注意**  
每個**AWS CDK 部署**動作只允許一個輸入 （來源或成品）。

對應的 UI：**輸入**索引標籤

## Sources
<a name="cdk.dep.inputs.sources"></a>

(*CDKDeploy*/Inputs/**Sources**)

（如果您要部署 AWS CDK 的應用程式存放在來源儲存庫中，則為必要項目）

如果您的 AWS CDK 應用程式存放在來源儲存庫中，請指定該來源儲存庫的標籤。**AWS CDK 部署**動作會在開始部署程序之前，在此儲存庫中合成應用程式。目前，唯一支援的標籤是 `WorkflowSource`。

如果您的 AWS CDK 應用程式不包含在來源儲存庫中，則必須位於另一個動作所產生的成品中。

如需來源的詳細資訊，請參閱 [將來源儲存庫連線至工作流程](workflows-sources.md)。

對應的 UI：輸入索引標籤/**來源 - 選用**

## Artifacts - input
<a name="cdk.dep.inputs.artifacts"></a>

(*CDKDeploy*/Inputs/**Artifacts**)

（如果您要部署 AWS CDK 的應用程式存放在先前動作的[輸出成品](workflows-working-artifacts-output.md)中，則為必要）

如果您的 AWS CDK 應用程式包含在先前動作產生的成品中，請在此處指定該成品。部署動作會在啟動**AWS CDK 部署**程序之前，將指定成品中的應用程式合成至 CloudFormation 範本。如果您的 AWS CDK 應用程式不包含在成品中，則必須位於您的來源儲存庫中。

如需成品的詳細資訊，包括範例，請參閱 [在動作之間共用成品和檔案](workflows-working-artifacts.md)。

對應的 UI：輸入索引標籤/**成品 - 選用**

## Outputs
<a name="cdk.dep.outputs"></a>

(*CDKDeploy*/**Outputs**)

(選用)

定義 動作在工作流程執行期間輸出的資料。

對應的 UI：**輸出**索引標籤

## Artifacts - output
<a name="cdk.dep.outputs.artifacts"></a>

(*CDKDeploy*/Outputs/**Artifacts**

(選用)

指定 動作產生的成品。您可以在其他動作中參考這些成品做為輸入。

如需成品的詳細資訊，包括範例，請參閱 [在動作之間共用成品和檔案](workflows-working-artifacts.md)。

對應的 UI：輸出索引標籤/**成品**

## Name
<a name="cdk.dep.outputs.artifacts.name"></a>

(*CDKDeploy*/Outputs/Artifacts/**Name**)

（如果[Artifacts - output](#cdk.dep.outputs.artifacts)包含 則為必要）

指定成品的名稱，該成品將包含由**AWS CDK 部署**動作在執行時間合成的 CloudFormation 範本。預設值為 `cdk_artifact`。如果您未指定成品，則動作會合成範本，但不會將其儲存在成品中。考慮將合成的範本儲存在成品中，以保留記錄以供測試或故障診斷之用。

對應的 UI：輸出tab/Artifacts/Add成品/**建置成品名稱**

## Files
<a name="cdk.dep.outputs.artifacts.files"></a>

(*CDKDeploy*/Outputs/Artifacts/**Files**)

（如果[Artifacts - output](#cdk.dep.outputs.artifacts)包含 則為必要）

指定要包含在成品中的檔案。您必須指定 `"cdk.out/**/*"`以包含 AWS CDK 應用程式的合成 CloudFormation 範本。

**注意**  
`cdk.out` 是將合成檔案儲存到其中的預設目錄。如果您在 `cdk.json` 檔案中指定 `cdk.out`以外的輸出目錄，請在此處指定該目錄，而非 `cdk.out`。

對應的 UI：輸出tab/Artifacts/Add**建置產生的成品/檔案**

## Environment
<a name="cdk.dep.environment"></a>

(*CDKDeploy*/**Environment**)

(必要)

指定要與 動作搭配使用的 CodeCatalyst 環境。動作會連線至所選環境中指定的 AWS 帳戶 和選用 Amazon VPC。動作會使用環境中指定的預設 IAM 角色來連線至 AWS 帳戶，並使用 [Amazon VPC 連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)中指定的 IAM 角色來連線至 Amazon VPC。

**注意**  
如果預設 IAM 角色沒有 動作所需的許可，您可以將動作設定為使用不同的角色。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

如需環境的詳細資訊，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)和 [建立環境](deploy-environments-creating-environment.md)。

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

## Name
<a name="cdk.dep.environment.name"></a>

(*CDKDeploy*/Environment/**Name**)

（如果[Environment](#cdk.dep.environment)包含 則為必要）

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

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

## Connections
<a name="cdk.dep.environment.connections"></a>

(*CDKDeploy*/Environment/**Connections**)

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

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

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

如需帳戶連線的詳細資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。如需將帳戶連線新增至環境的相關資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Name
<a name="cdk.dep.environment.connections.name"></a>

(*CDKDeploy*/Environment/Connections/**Name**)

（如果[Connections](#cdk.dep.environment.connections)包含 則為必要）

指定帳戶連線的名稱。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Role
<a name="cdk.dep.environment.connections.role"></a>

(*CDKDeploy*/Environment/Connections/**Role**)

（如果[Connections](#cdk.dep.environment.connections)包含 則為必要）

指定帳戶連線的名稱。

指定**AWS CDK 部署**動作用來存取 AWS 和部署 AWS CDK 應用程式堆疊的 IAM 角色名稱。請確定您已[將角色新增至 CodeCatalyst 空間](ipa-connect-account-addroles.md)，且該角色包含下列政策。

如果您未指定 IAM 角色，則動作會使用 CodeCatalyst 主控台中[環境中](deploy-environments.md)列出的預設 IAM 角色。如果您在環境中使用預設角色，請確定其具有下列政策。
+ 下列許可政策：
**警告**  
將許可限制為下列政策中顯示的許可。使用具有更廣泛許可的角色可能會帶來安全風險。

------
#### [ JSON ]

****  

  ```
  {
      "Version":"2012-10-17",		 	 	 
      "Statement": [
          {
              "Sid": "VisualEditor0",
              "Effect": "Allow",
              "Action": [
                  "cloudformation:DescribeStackEvents",
                  "cloudformation:DescribeChangeSet",
                  "cloudformation:DescribeStacks",
                  "cloudformation:ListStackResources"
              ],
              "Resource": "*"
          },
          {
              "Sid": "VisualEditor1",
              "Effect": "Allow",
              "Action": "sts:AssumeRole",
              "Resource": "arn:aws:iam::111122223333:role/cdk-*"
          }
      ]
  }
  ```

------
+ 下列自訂信任政策：

**注意**  
如有需要，您可以使用 `CodeCatalystWorkflowDevelopmentRole-spaceName`角色搭配此動作。如需有關此角色的詳細資訊，請參閱 [為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有可能造成安全風險的完整存取許可。我們建議您只在安全性較少的教學課程和案例中使用此角色。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What*我的環境*是什麼？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**Role**

## Configuration
<a name="cdk.dep.configuration"></a>

(*CDKDeploy*/**Configuration**)

(必要)

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

對應的 UI：**組態**索引標籤

## StackName
<a name="cdk.dep.stack.name"></a>

(*CDKDeploy*/Configuration/**StackName**)

(必要)

應用程式 AWS CDK 堆疊的名稱，如應用程式 AWS CDK `bin`目錄中的進入點檔案中所示。下列範例顯示 TypeScript 進入點檔案的內容，堆疊名稱以*紅色斜體*反白顯示。如果您的進入點檔案使用不同的語言，它看起來會相似。

```
import * as cdk from 'aws-cdk-lib';
import { CdkWorksopTypescriptStack } from '../lib/cdk_workshop_typescript-stack';

const app = new cdk.App();
new CdkWorkshopTypescriptStack(app, 'CdkWorkshopTypescriptStack');
```

您只能指定一個堆疊。

**提示**  
如果您有多個堆疊，您可以使用巢狀堆疊建立父堆疊。然後，您可以在此動作中指定父堆疊來部署所有堆疊。

對應的 UI：組態索引標籤/**堆疊名稱**

## Region
<a name="cdk.dep.region"></a>

(*CDKDeploy*/Configuration/**Region**)

(選用)

指定要部署 AWS CDK 應用程式堆疊的 AWS 區域 。如需區域代碼清單，請參閱[區域端點](https://docs.aws.amazon.com/general/latest/gr/rande.html#region-names-codes)。

如果您未指定區域，**AWS CDK 部署**動作會部署到 AWS CDK 程式碼中指定的區域。如需詳細資訊，請參閱《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*[》中的環境](https://docs.aws.amazon.com/cdk/v2/guide/environments.html)。

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

## Tags
<a name="cdk.dep.tags"></a>

(*CDKDeploy*/Configuration/**Tags**)

(選用)

指定您要套用至 AWS CDK 應用程式堆疊中 AWS 資源的標籤。標籤會套用至堆疊本身，以及堆疊中的個別資源。如需標記的詳細資訊，請參閱《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*》中的[標記](https://docs.aws.amazon.com/cdk/v2/guide/tagging.html)。

對應的 UI：組態索引標籤/進階 - 選用/**標籤**

## Context
<a name="cdk.dep.context"></a>

(*CDKDeploy*/Configuration/**Context**)

(選用)

以鍵值對的形式指定要與 AWS CDK 應用程式堆疊建立關聯的內容。如需內容的詳細資訊，請參閱《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*》中的[執行期內容](https://docs.aws.amazon.com/cdk/v2/guide/context.html)。

對應的 UI：組態索引標籤/進階 - 選用/**內容**

## CdkCliVersion
<a name="cdk.dep.cdk.cli.version"></a>

(*CDKDeploy*/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 [建置映像](build-images.md)，然後使用此版本來執行部署 CDK 應用程式或引導環境 AWS 所需的命令。

如需您可以使用的支援 CDK CLI 版本清單，請參閱[AWS CDK 版本](https://docs.aws.amazon.com/cdk/api/versions.html)。

如果您省略此屬性，動作會使用下列其中一個主題所述的預設 AWS CDK CLI 版本：
+ [「AWS CDK 部署」動作使用的 CDK CLI 版本](cdk-dep-action.md#cdk-dep-action-cdk-version) 
+ ["AWS CDK bootstrap" 動作使用的 CDK CLI 版本](cdk-boot-action.md#cdk-boot-action-cdk-version)

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

## CdkRootPath
<a name="cdk.dep.cdk.root.path"></a>

(*CDKDeploy*/Configuration/**CdkRootPath**)

(選用)

包含 AWS CDK 專案`cdk.json`檔案的目錄路徑。**AWS CDK 部署**動作會從此資料夾執行，而動作建立的任何輸出都會新增至此目錄。如果未指定，**AWS CDK 部署**動作會假設 `cdk.json` 檔案位於 AWS CDK 專案的根目錄中。

對應的 UI：組態索引標籤/**cdk.json 所在的目錄**

## CfnOutputVariables
<a name="cdk.dep.cfn.out"></a>

(*CDKDeploy*/Configuration/**CfnOutputVariables**)

(選用)

指定您要在 AWS CDK 應用程式程式碼中公開為工作流程輸出變數的`CfnOutput`建構。然後，您可以在工作流程的後續動作中參考工作流程輸出變數。如需 CodeCatalyst 中變數的詳細資訊，請參閱 [在工作流程中使用變數](workflows-working-with-variables.md)。

例如，如果您 AWS CDK 的應用程式程式碼如下所示：

```
import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as s3 from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
import * as cdk from 'aws-cdk-lib';
export class HelloCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
      removalPolicy: RemovalPolicy.DESTROY,
    });
    new CfnOutput(this, 'bucketName', {
      value: bucket.bucketName,
      description: 'The name of the s3 bucket',
      exportName: 'amzn-s3-demo-bucket',
    });
    const table = new dynamodb.Table(this, 'todos-table', {
      partitionKey: {name: 'todoId', type: dynamodb.AttributeType.NUMBER},
      billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
      removalPolicy: RemovalPolicy.DESTROY,
    })
    new CfnOutput(this, 'tableName', {
      value: table.tableName,
      description: 'The name of the dynamodb table',
      exportName: 'myDynamoDbTable',
    });
    ...
  }
}
```

...而您的`CfnOutputVariables`屬性如下所示：

```
Configuration:
  ...
  CfnOutputVariables: '["bucketName","tableName"]'
```

...然後動作會產生下列工作流程輸出變數：


| 金鑰 | 值 | 
| --- | --- | 
|  bucketName  |  `bucket.bucketName`  | 
|  tableName  |  `table.tableName`  | 

然後，您可以在後續動作中參考 `bucketName`和 `tableName`變數。若要了解如何在後續動作中參考工作流程輸出變數，請參閱 [參考預先定義的變數](workflows-working-with-variables-reference-output-vars.md)。

如果您未在 `CfnOutputVariables` 屬性中指定任何`CfnOutput`建構，則動作會公開其視為工作流程輸出變數的前四個 （或更少） CloudFormation 輸出變數。如需詳細資訊，請參閱[「AWS CDK 部署」變數](cdk-dep-action-variables.md)。

**提示**  
若要取得動作產生的所有 CloudFormation 輸出變數清單，請執行包含**AWS CDK 部署**動作的工作流程一次，然後查看動作的**日誌**索引標籤。日誌包含與您的 AWS CDK 應用程式相關聯的所有 CloudFormation 輸出變數清單。知道所有 CloudFormation 變數是什麼後，您可以使用 `CfnOutputVariables` 屬性指定要轉換為工作流程輸出變數的變數。

如需 CloudFormation 輸出變數的詳細資訊，請參閱 API `CfnOutput` 參考中的建構文件，可在 [ CfnOutput （建構） 類別](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnOutput.html)取得。 *AWS Cloud Development Kit (AWS CDK) *

對應的 UI：組態索引標籤/**CloudFormation 輸出變數**

## CloudAssemblyRootPath
<a name="cdk.dep.cloud"></a>

(*CDKDeploy*/Configuration/**CloudAssemblyRootPath**)

(選用)

如果您已將 AWS CDK 應用程式的堆疊合成至雲端組件 （使用 `cdk synth`操作），請指定雲端組件目錄的根路徑 (`cdk.out`)。位於指定雲端組件目錄中的 CloudFormation 範本，將由**AWS CDK 部署**動作 AWS 帳戶 使用 `cdk deploy --app`命令部署至您的 。當 `--app`選項存在時，不會發生 `cdk synth`操作。

如果您未指定雲端組件目錄，則**AWS CDK 部署**動作將在沒有 `--app`選項的情況下執行 `cdk deploy`命令。如果沒有 `--app`選項，`cdk deploy`操作將同時合成 (`cdk synth`) 並將您的 AWS CDK 應用程式部署到您的 AWS 帳戶。

**當「AWS CDK 部署」動作可以在執行時間進行合成時，為什麼要指定現有的合成雲端組件？**

您可能想要指定現有的合成雲端組件，以：
+ **確保每次「部署」動作執行時，都會AWS CDK 部署完全相同的資源集**

  如果您未指定雲端組件，**AWS CDK 則部署**動作可能會根據執行時間來合成和部署不同的檔案。例如，**AWS CDK 部署**動作可能會在測試階段期間合成具有一組相依性的雲端組件，以及在生產階段期間合成另一組相依性 （如果這些相依性在階段之間變更）。為了確保測試內容與部署內容之間的完全相同性，我們建議合成一次，然後使用**路徑到雲端組件目錄**欄位 （視覺化編輯器） 或`CloudAssemblyRootPath`屬性 (YAML 編輯器） 來指定已合成的雲端組件。
+ **搭配 AWS CDK 應用程式使用非標準套件管理員和工具**

  在`synth`操作期間，**AWS CDK 部署**動作會嘗試使用標準工具執行您的應用程式，例如 npm 或 pip。如果動作無法使用這些工具成功執行您的應用程式，則不會進行合成，且動作會失敗。若要解決此問題，您可以在應用程式的 AWS CDK `cdk.json` 檔案中指定成功執行應用程式所需的確切命令，然後使用不涉及**AWS CDK 部署**動作的方法合成應用程式。產生雲端組件之後，您可以在**AWS CDK 部署**動作的**雲端組件目錄路徑**欄位 （視覺化編輯器） 或`CloudAssemblyRootPath`屬性 (YAML 編輯器） 中指定它。

如需設定 `cdk.json` 檔案以包含安裝和執行 AWS CDK 應用程式的命令的詳細資訊，請參閱[指定應用程式命令](https://docs.aws.amazon.com/cdk/v2/guide/cli.html#cli-app-command)。

如需 `cdk deploy`和 `cdk synth`命令以及 `--app`選項的相關資訊，請參閱《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*》中的[部署堆疊](https://docs.aws.amazon.com/cdk/v2/guide/cli.html#cli-deploy)、[合成堆疊](https://docs.aws.amazon.com/cdk/v2/guide/cli.html#cli-synth)和[略過合成](https://docs.aws.amazon.com/cdk/v2/guide/cli.html#cli-deploy-nosynth)。

如需雲端組件的相關資訊，請參閱 *AWS Cloud Development Kit (AWS CDK) API 參考*中的[雲端組件](https://docs.aws.amazon.com/cdk/api/v2/docs/cloud-assembly-schema-readme.html)。

對應的 UI：組態索引標籤/**通往雲端組件目錄的路徑**

# 使用工作流程引導 AWS CDK 應用程式
<a name="cdk-boot-action"></a>

本節說明如何使用 CodeCatalyst 工作流程引導 AWS CDK 應用程式。若要達成此目的，您必須將**AWS CDK 引導**操作新增至工作流程。**AWS CDK 引導**操作會使用[現代範本](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html#bootstrapping-template)在您的 AWS 環境中佈建引導堆疊。如果引導堆疊已存在，動作會視需要更新它。在 中具有引導堆疊 AWS 是部署 AWS CDK 應用程式的先決條件。

如需引導的詳細資訊，請參閱《 *AWS Cloud Development Kit (AWS CDK) 開發人員指南*》中的[引導](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html)。

**Topics**
+ [何時使用 'AWS CDK bootstrap' 動作](#cdk-boot-action-when-to-use)
+ [「AWS CDK bootstrap」動作的運作方式](#cdk-boot-action-how-it-works)
+ ["AWS CDK bootstrap" 動作使用的 CDK CLI 版本](#cdk-boot-action-cdk-version)
+ [「AWS CDK bootstrap」動作所使用的執行期映像](#cdk-boot-action-runtime)
+ [範例：引導 AWS CDK 應用程式](cdk-boot-action-example-workflow.md)
+ [新增 'AWS CDK bootstrap' 動作](cdk-boot-action-add.md)
+ ['AWS CDK bootstrap' 變數](cdk-boot-action-variables.md)
+ [「AWS CDK 引導」動作 YAML](cdk-boot-action-ref.md)

## 何時使用 'AWS CDK bootstrap' 動作
<a name="cdk-boot-action-when-to-use"></a>

如果您有部署 AWS CDK 應用程式的工作流程，而且您想要同時部署 （並視需要更新） 引導堆疊，請使用此動作。在此情況下，您會將**AWS CDK 引導**操作新增至與部署 AWS CDK 應用程式相同的工作流程。

如果符合下列任一條件，**請勿使用**此動作：
+ 您已使用另一個機制部署引導堆疊，而且想要保持完整 （無更新）。
+ 您想要使用[自訂引導範本，該範本](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html#bootstrapping-customizing)不受**AWS CDK 引導**動作支援。

## 「AWS CDK bootstrap」動作的運作方式
<a name="cdk-boot-action-how-it-works"></a>

**AWS CDK 引導運作**方式如下：

1. 在執行時間，如果您指定 動作的 1.0.7 版或更早版本，動作會將最新的 CDK CLI （也稱為 AWS CDK Tookit) 下載至 CodeCatalyst [建置映像](build-images.md)。

   如果您指定 1.0.8 版或更新版本，動作會隨附[特定版本的](cdk-dep-action.md#cdk-dep-action-cdk-version) CDK CLI，因此不會進行下載。

1. 動作會使用 CDK CLI 來執行 `cdk bootstrap`命令。此命令會執行*AWS Cloud Development Kit (AWS CDK) 開發人員指南*中引導主題中所述的[引導](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html)任務。

## "AWS CDK bootstrap" 動作使用的 CDK CLI 版本
<a name="cdk-boot-action-cdk-version"></a>

下表顯示不同的**AWS CDK 引導**操作版本預設使用的 CDK CLI 版本。

**注意**  
您可能可以覆寫預設值。如需詳細資訊，請參閱 [「AWS CDK 引導」動作 YAML](cdk-boot-action-ref.md) 中的 [CdkCliVersion](cdk-boot-action-ref.md#cdk.boot.cdk.cli.version)。


| 'AWS CDK bootstrap' 動作版本 | AWS CDK CLI 版本 | 
| --- | --- | 
|  1.0.0 – 1.0.7  |  最新  | 
|  1.0.8 或更新版本  |  2.99.1  | 

## 「AWS CDK bootstrap」動作所使用的執行期映像
<a name="cdk-boot-action-runtime"></a>

下表顯示 CodeCatalyst 用來執行不同版本**AWS CDK 引導**操作的執行期環境映像。影像包含不同的預先安裝工具集。如需詳細資訊，請參閱[作用中映像](build-images.md#build-curated-images)。

**注意**  
我們建議您將**AWS CDK 引導**操作升級至 2.x 版，以利用 2024 年 3 月映像中可用的最新工具。若要升級動作，`aws/cdk-bootstrap@v2`請在工作流程定義檔案中將其`Identifier`屬性設定為 。如需詳細資訊，請參閱[「AWS CDK 部署」動作 YAML](cdk-dep-action-ref.md)。


| 'AWS CDK bootstrap' 動作版本 | 執行期環境映像 | 
| --- | --- | 
|  1.x  |  2022 年 11 月影像  | 
|  2.x  |  2024 年 3 月影像  | 

# 範例：引導 AWS CDK 應用程式
<a name="cdk-boot-action-example-workflow"></a>

如需包含**AWS CDK 引導**操作的[使用工作流程部署 AWS CDK 應用程式](cdk-dep-action.md)工作流程，請參閱 [範例：部署 AWS CDK 應用程式](cdk-dep-action-example-workflow.md) 中的 。

# 新增 'AWS CDK bootstrap' 動作
<a name="cdk-boot-action-add"></a>

 使用下列指示將**AWS CDK 引導**操作新增至您的工作流程。

**開始之前**

在您可以使用**AWS CDK 引導**操作之前，請確定您已備妥 AWS CDK 應用程式。引導操作會在引導之前合成 AWS CDK 應用程式。您可以使用 支援的任何程式設計語言撰寫應用程式 AWS CDK。

確保您的 AWS CDK 應用程式檔案可用於：
+ CodeCatalyst [來源儲存庫](source.md)，或 
+ 由另一個工作流程動作產生的 CodeCatalyst [輸出成品](workflows-working-artifacts.md) 

------
#### [ Visual ]

**使用視覺化編輯器新增 'AWS CDK bootstrap' 動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋**AWS CDK 引導**操作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇**AWS CDK 引導。**動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**檢視來源**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 在**輸入**、**組態**和**輸出**索引標籤中，根據您的需求完成欄位。如需每個欄位的說明，請參閱 [「AWS CDK 引導」動作 YAML](cdk-boot-action-ref.md)。此參考提供在 YAML 和視覺化編輯器中顯示的每個欄位 （和對應的 YAML 屬性值） 的詳細資訊。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。
**注意**  
如果您的**AWS CDK 引導**操作失敗並發生錯誤`npm install`，請參閱 以取得如何修正錯誤[如何修正「npm 安裝」錯誤？](troubleshooting-workflows.md#troubleshooting-workflows-npm)的資訊。

------
#### [ YAML ]

**使用 YAML 編輯器新增 'AWS CDK bootstrap' 動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋**AWS CDK 引導**操作，然後選擇 **\$1** 將其新增至工作流程圖表，並開啟其組態窗格。

1. 根據您的需求修改 YAML 程式碼中的屬性。中提供了每個可用屬性的說明[「AWS CDK 引導」動作 YAML](cdk-boot-action-ref.md)。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。
**注意**  
如果您的**AWS CDK 引導**操作失敗並發生錯誤`npm install`，請參閱 以取得如何修正錯誤[如何修正「npm 安裝」錯誤？](troubleshooting-workflows.md#troubleshooting-workflows-npm)的資訊。

------

# 'AWS CDK bootstrap' 變數
<a name="cdk-boot-action-variables"></a>

**AWS CDK 引導**操作會在執行時間產生並設定下列變數。這些稱為*預先定義的變數*。

如需在工作流程中參考這些變數的資訊，請參閱 [使用預先定義的變數](workflows-using-predefined-variables.md)。


| 金鑰 | 值 | 
| --- | --- | 
|  deployment-platform  |  部署平台的名稱。 硬式編碼為 `AWS:CloudFormation`。  | 
|  region  |  在工作流程執行期間 AWS CDK 部署引導堆疊 AWS 區域 的 區域碼。 範例：`us-west-2`  | 
|  stack-id  |  部署 AWS CDK 引導堆疊的 Amazon Resource Name (ARN)。 範例：`arn:aws:cloudformation:us-west-2:111122223333:stack/codecatalyst-cdk-bootstrap-stack/6aad4380-100a-11ec-a10a-03b8a84d40df`  | 
|  SKIP-DEPLOYMENT  |  值 `true`表示在工作流程執行期間略過 AWS CDK 了引導堆疊的部署。如果堆疊自上次部署以來沒有變更，則會略過堆疊部署。 只有在其值為 時，才會產生此變數`true`。 硬式編碼為 `true`。  | 

# 「AWS CDK 引導」動作 YAML
<a name="cdk-boot-action-ref"></a>

以下是**AWS CDK 引導**操作的 YAML 定義。若要了解如何使用此動作，請參閱 [使用工作流程引導 AWS CDK 應用程式](cdk-boot-action.md)。

此動作定義以區段的形式存在於更廣泛的工作流程定義檔案中。如需有關此檔案的詳細資訊，請參閱[工作流程 YAML 定義](workflow-reference.md)。

**注意**  
下列大多數 YAML 屬性在視覺化編輯器中都有對應的 UI 元素。若要查詢 UI 元素，請使用 **Ctrl\$1F**。 元素將與其相關聯的 YAML 屬性一起列出。

```
# The workflow definition starts here.
# See 最上層屬性 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  CDKBootstrapAction\$1nn: 
    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 name="cdk.boot.name"></a>

(必要)

指定動作的名稱。工作流程中的所有動作名稱都必須是唯一的。動作名稱僅限於英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (\$1)。不允許空格。您無法使用引號在動作名稱中啟用特殊字元和空格。

預設：`CDKBootstrapAction_nn`。

對應的 UI：組態索引標籤/**動作顯示名稱**

## Identifier
<a name="cdk.boot.identifier"></a>

(*CDKBootstrapAction*/**Identifier**)

(必要)

識別 動作。除非您想要變更版本，否則請勿變更此屬性。如需詳細資訊，請參閱[指定要使用的動作版本](workflows-action-versions.md)。

**注意**  
指定 `aws/cdk-bootstrap@v2`會導致 動作在 [2024 年 3 月映像](build-images.md#build.default-image)上執行，其中包括較新的工具，例如 Node.js 18。指定 `aws/cdk-bootstrap@v1`會導致 動作在 [2022 年 11 月映像](build-images.md#build.previous-image)上執行，其中包含舊版工具，例如 Node.js 16。

預設：`aws/cdk-bootstrap@v2`。

對應的 UI：工作流程圖表/CDKBootstrapAction\$1nn/**aws/cdk-bootstrap@v2** 標籤

## DependsOn
<a name="cdk.boot.dependson"></a>

(*CDKBootstrapAction*/**DependsOn**)

(選用)

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

如需 'depends on' 功能的詳細資訊，請參閱 [定序動作](workflows-depends-on.md)。

對應的 UI：輸入索引標籤/**取決於 - 選用**

## Compute
<a name="cdk.boot.computename"></a>

(*CDKBootstrapAction*/**Compute**)

(選用)

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

對應的 UI：*無*

## Type
<a name="cdk.boot.computetype"></a>

(*CDKBootstrapAction*/Compute/**Type**)

（如果[Compute](#cdk.boot.computename)包含 則為必要）

運算引擎的類型。您可以使用下列其中一個值：
+ **EC2** （視覺化編輯器） 或 `EC2`(YAML 編輯器）

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

  最佳化動作啟動速度。

如需運算類型的更多相關資訊，請參閱[運算類型](workflows-working-compute.md#compute.types)。

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

## Fleet
<a name="cdk.boot.computefleet"></a>

(*CDKBootstrapAction*/Compute/**Fleet**)

(選用)

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

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

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

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

## Timeout
<a name="cdk.boot.timeout"></a>

(*CDKBootstrapAction*/**Timeout**)

(必要)

指定動作在 CodeCatalyst 結束動作之前可執行的時間，以分鐘為單位 (YAML 編輯器） 或小時和分鐘為單位。最小值為 5 分鐘，最大值如 中所述[CodeCatalyst 中工作流程的配額](workflows-quotas.md)。預設逾時與最大逾時相同。

對應的 UI：組態索引標籤/**逾時 - 選用 **

## Inputs
<a name="cdk.boot.inputs"></a>

(*CDKBootstrapAction*/**Inputs**)

(選用)

`Inputs` 區段定義在工作流程執行期間**AWS CDK 引導**操作所需的資料。

對應的 UI：**輸入**索引標籤

**注意**  
每個**AWS CDK 引導**操作只允許一個輸入 （來源或成品）。

## Sources
<a name="cdk.boot.inputs.sources"></a>

(*CDKBootstrapAction*/Inputs/**Sources**)

（如果您 AWS CDK 的應用程式存放在來源儲存庫中，則為必要項目）

如果您的 AWS CDK 應用程式存放在來源儲存庫中，請指定該來源儲存庫的標籤。**AWS CDK 引導**操作會在啟動引導程序之前，在此儲存庫中合成應用程式。目前，唯一支援的儲存庫標籤是 `WorkflowSource`。

如果您的 AWS CDK 應用程式不包含在來源儲存庫中，則必須位於另一個動作所產生的成品中。

如需來源的詳細資訊，請參閱 [將來源儲存庫連線至工作流程](workflows-sources.md)。

對應的 UI：輸入索引標籤/**來源 - 選用**

## Artifacts - input
<a name="cdk.boot.inputs.artifacts"></a>

(*CDKBootstrapAction*/Inputs/**Artifacts**)

（如果您 AWS CDK 的應用程式存放在先前動作的[輸出成品](workflows-working-artifacts-output.md)中，則為必要）

如果您的 AWS CDK 應用程式包含在先前動作產生的成品中，請在此處指定該成品。**AWS CDK 引導**操作會在啟動引導程序之前，將指定成品中的應用程式合成為 CloudFormation 範本。如果您的 AWS CDK 應用程式不包含在成品中，它必須位於您的來源儲存庫中。

如需成品的詳細資訊，包括範例，請參閱 [在動作之間共用成品和檔案](workflows-working-artifacts.md)。

對應的 UI：輸入索引標籤/**文章 - 選用**

## Outputs
<a name="cdk.boot.outputs"></a>

(*CDKBootstrapAction*/**Outputs**)

(選用)

定義 動作在工作流程執行期間輸出的資料。

對應的 UI：**輸出**索引標籤

## Artifacts - output
<a name="cdk.boot.outputs.artifacts"></a>

(*CDKBootstrapAction*/Outputs/**Artifacts**)

(選用)

指定 動作產生的成品。您可以在其他動作中參考這些成品做為輸入。

如需成品的詳細資訊，包括範例，請參閱 [在動作之間共用成品和檔案](workflows-working-artifacts.md)。

對應的 UI：輸出索引標籤/**成品**

## Name
<a name="cdk.boot.outputs.artifacts.name"></a>

(*CDKBootstrapAction*/Outputs/Artifacts/**Name**)

（如果[Artifacts - output](#cdk.boot.outputs.artifacts)包含 則為必要）

指定成品的名稱，該成品將包含由**AWS CDK 引導**操作在執行時間合成的 CloudFormation 範本。預設值為 `cdk_bootstrap_artifacts`。如果您未指定成品，則動作會合成範本，但不會將其儲存在成品中。考慮將合成的範本儲存在成品中，以保留記錄以供測試或故障診斷之用。

對應的 UI：輸出tab/Artifacts/Add成品/**建置成品名稱**

## Files
<a name="cdk.boot.outputs.artifacts.files"></a>

(*CDKBootstrapAction*/Outputs/Artifacts/**Files**)

（如果[Artifacts - output](#cdk.boot.outputs.artifacts)包含 則為必要）

指定要包含在成品中的檔案。您必須指定 `"cdk.out/**/*"`以包含 AWS CDK 應用程式的合成 CloudFormation 範本。

**注意**  
`cdk.out` 是將合成檔案儲存到其中的預設目錄。如果您在 `cdk.json` 檔案中指定 `cdk.out`以外的輸出目錄，請在此處指定該目錄，而非 `cdk.out`。

對應的 UI：輸出tab/Artifacts/Add**建置產生的成品/檔案**

## Environment
<a name="cdk.boot.environment"></a>

(*CDKBootstrapAction*/**Environment**)

(必要)

指定要與 動作搭配使用的 CodeCatalyst 環境。動作會連線至所選環境中指定的 AWS 帳戶 和選用 Amazon VPC。動作會使用環境中指定的預設 IAM 角色來連線至 AWS 帳戶，並使用 [Amazon VPC 連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)中指定的 IAM 角色來連線至 Amazon VPC。

**注意**  
如果預設 IAM 角色沒有 動作所需的許可，您可以將動作設定為使用不同的角色。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

如需環境的詳細資訊，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)和 [建立環境](deploy-environments-creating-environment.md)。

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

## Name
<a name="cdk.boot.environment.name"></a>

(*CDKBootstrapAction*/Environment/**Name**)

（如果[Environment](#cdk.boot.environment)包含 則為必要）

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

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

## Connections
<a name="cdk.boot.environment.connections"></a>

(*CDKBootstrapAction*/Environment/**Connections**)

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

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

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

如需帳戶連線的詳細資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。如需將帳戶連線新增至環境的相關資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What*我的環境*是什麼？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Name
<a name="cdk.boot.environment.connections.name"></a>

(*CDKBootstrapAction*/Environment/Connections/**Name**)

（如果[Connections](#cdk.boot.environment.connections)包含 則為必要）

指定帳戶連線的名稱。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Role
<a name="cdk.boot.environment.connections.role"></a>

(*CDKBootstrapAction*/Environment/Connections/**Role**)

（如果[Connections](#cdk.boot.environment.connections)包含 則為必要）

指定**AWS CDK 引導**操作用來存取 AWS 和新增引導堆疊的 IAM 角色名稱。請確定您已[將角色新增至 CodeCatalyst 空間](ipa-connect-account-addroles.md)，且該角色包含下列政策。

如果您未指定 IAM 角色，則動作會使用 CodeCatalyst 主控台中[環境中](deploy-environments.md)列出的預設 IAM 角色。如果您在環境中使用預設角色，請確定其具有適當的政策。

如有需要，您可以使用 `CodeCatalystWorkflowDevelopmentRole-spaceName`角色搭配此動作。如需有關此角色的詳細資訊，請參閱 [為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有可能造成安全風險的完整存取許可。我們建議您只在安全性較少的教學課程和案例中使用此角色。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**Role**

## Configuration
<a name="cdk.boot.configuration"></a>

(*CDKBootstrapAction*/**Configuration**)

(必要)

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

對應的 UI：**組態**索引標籤

## Region
<a name="cdk.boot.region"></a>

(*CDKBootstrapAction*/Configuration/**Region**)

(必要)

指定要部署引導堆疊的 AWS 區域 。此區域應與您的 AWS CDK 應用程式部署所在的區域相符。如需區域代碼清單，請參閱[區域端點](https://docs.aws.amazon.com/general/latest/gr/rande.html#region-names-codes)。

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

## CdkCliVersion
<a name="cdk.boot.cdk.cli.version"></a>

(*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 [建置映像](build-images.md)，然後使用此版本來執行部署 CDK 應用程式或引導環境 AWS 所需的命令。

如需您可以使用的支援 CDK CLI 版本清單，請參閱[AWS CDK 版本](https://docs.aws.amazon.com/cdk/api/versions.html)。

如果您省略此屬性，動作會使用下列其中一個主題所述的預設 AWS CDK CLI 版本：
+ [「AWS CDK 部署」動作使用的 CDK CLI 版本](cdk-dep-action.md#cdk-dep-action-cdk-version) 
+ ["AWS CDK bootstrap" 動作使用的 CDK CLI 版本](cdk-boot-action.md#cdk-boot-action-cdk-version)

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

# 使用工作流程將檔案發佈至 Amazon S3
<a name="s3-pub-action"></a>

本節說明如何使用 CodeCatalyst 工作流程將檔案發佈至 Amazon S3。若要達成此目的，您必須將 **Amazon S3 發佈**動作新增至工作流程。**Amazon S3 發佈**動作會將檔案從來源目錄複製到 Amazon S3 儲存貯體。來源目錄可以位於：
+ [來源儲存庫](source.md)，或 
+ 另一個工作流程動作產生的[輸出成品](workflows-working-artifacts.md) 

**Topics**
+ [何時使用 'Amazon S3 發佈' 動作](#s3-pub-action-when-to-use)
+ [「Amazon S3 發佈」動作使用的執行期映像](#s3-pub-action-runtime)
+ [範例：將檔案發佈至 Amazon S3](s3-pub-action-example-workflow.md)
+ [新增「Amazon S3 發佈」動作](s3-pub-action-add.md)
+ [「Amazon S3 發佈」動作 YAML](s3-pub-action-ref.md)

## 何時使用 'Amazon S3 發佈' 動作
<a name="s3-pub-action-when-to-use"></a>

在以下情況下使用此動作：
+ 您的工作流程會產生要存放在 Amazon S3 中的檔案。

  例如，您可能有一個工作流程，其會建置您想要在 Amazon S3 中託管的靜態網站。在這種情況下，您的工作流程將包括建置網站 HTML 和支援檔案的[建置動作](build-add-action.md)，以及將檔案複製到 **Amazon S3 的 Amazon S3 發佈**動作。 Amazon S3
+ 您有一個來源儲存庫，其中包含要存放在 Amazon S3 中的檔案。

  例如，您可能有一個來源儲存庫，其中包含您想要在夜間封存至 Amazon S3 的應用程式來源檔案。

## 「Amazon S3 發佈」動作使用的執行期映像
<a name="s3-pub-action-runtime"></a>

**Amazon S3 發佈**動作會在 [2022 年 11 月的映像](build-images.md#build.previous-image)上執行。如需詳細資訊，請參閱[作用中映像](build-images.md#build-curated-images)。

# 範例：將檔案發佈至 Amazon S3
<a name="s3-pub-action-example-workflow"></a>

下列範例工作流程包含 **Amazon S3 發佈**動作，以及建置動作。工作流程會建置靜態文件網站，然後將其發佈至託管的 Amazon S3。工作流程包含下列依順序執行的建置區塊：
+ **觸發**條件 – 當您將變更推送至來源儲存庫時，此觸發條件會自動啟動工作流程執行。關於觸發條件的詳細資訊，請參閱 [使用觸發程序自動啟動工作流程執行](workflows-add-trigger.md)。
+ **建置**動作 (`BuildDocs`) – 在觸發時，動作會建置靜態文件網站 (`mkdocs build`)，並將相關聯的 HTML 檔案和支援中繼資料新增至名為 的成品`MyDocsSite`。如需建置動作的詳細資訊，請參閱 [使用工作流程建置](build-workflow-actions.md)。
+ **Amazon S3 發佈**動作 (`PublishToS3`) – 建置動作完成後，此動作會將`MyDocsSite`成品中的網站複製到 Amazon S3 進行託管。

**注意**  
下列工作流程範例僅供說明之用，如果沒有其他組態，將無法運作。

**注意**  
在後續的 YAML 程式碼中，您可以視需要省略 `Connections:`區段。如果您省略本節，您必須確保環境中**預設 IAM 角色**欄位中指定的角色包含 **Amazon S3 發佈**動作所需的許可和信任政策。如需使用預設 IAM 角色設定環境的詳細資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。如需 **Amazon S3 發佈**動作所需許可和信任政策的詳細資訊，請參閱 中的 [Role](s3-pub-action-ref.md#s3.pub.environment.connections.role) 屬性描述[「Amazon S3 發佈」動作 YAML](s3-pub-action-ref.md)。

```
Name: codecatalyst-s3-publish-workflow
SchemaVersion: 1.0

Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  BuildDocs:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
        - Run: echo BuildDocs started on `date`
        - Run: pip install --upgrade pip
        - Run: pip install mkdocs
        - Run: mkdocs build
        - Run: echo BuildDocs completed on `date`
    Outputs:
      Artifacts:
      - Name: MyDocsSite
        Files:
          - "site/**/*"
        
  PublishToS3:
    Identifier: aws/s3-publish@v1
    Environment:
      Name: codecatalyst-s3-publish-environment
      Connections:
        - Name: codecatalyst-account-connection
          Role: codecatalyst-s3-publish-build-role
    Inputs:
      Sources:
        - WorkflowSource
      Artifacts:
        - MyDocsSite
    Configuration:      
      DestinationBucketName: amzn-s3-demo-bucket
      SourcePath: /artifacts/PublishToS3/MyDocSite/site
      TargetPath: my/docs/site
```

# 新增「Amazon S3 發佈」動作
<a name="s3-pub-action-add"></a>

 使用下列指示將 **Amazon S3 發佈**動作新增至您的工作流程。

------
#### [ Visual ]

**使用視覺化編輯器新增「Amazon S3 發佈」動作**

1. 開啟 CodeCatalyst 主控台，網址為 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/)。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中選擇 **Amazon CodeCatalyst**。

1. 搜尋 **Amazon S3 發佈**動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇 **Amazon S3 發佈**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**檢視來源**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 在**輸入**、**組態**和**輸出**索引標籤中，根據您的需求完成欄位。如需每個欄位的說明，請參閱 [「Amazon S3 發佈」動作 YAML](s3-pub-action-ref.md)。此參考提供每個欄位 （和對應的 YAML 屬性值） 的詳細資訊，如 YAML 和視覺化編輯器所示。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------
#### [ YAML ]

**使用 YAML 編輯器新增「Amazon S3 發佈」動作**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在左上角，選擇 **\$1 動作**以開啟動作目錄。

1. 從下拉式清單中，選擇 **Amazon CodeCatalyst**。

1. 搜尋 **Amazon S3 發佈**動作，並執行下列其中一項操作：
   + 選擇加號 (**\$1**) 將動作新增至工作流程圖表，並開啟其組態窗格。

     或
   + 選擇 **Amazon S3 發佈**。動作詳細資訊對話方塊隨即出現。在此對話方塊中：
     + （選用） 選擇**檢視來源**[以檢視動作的原始程式碼](workflows-view-source.md#workflows-view-source.title)。
     + 選擇**新增至工作流程**，將動作新增至工作流程圖表，然後開啟其組態窗格。

1. 根據您的需求修改 YAML 程式碼中的屬性。中提供了每個可用屬性的說明[「Amazon S3 發佈」動作 YAML](s3-pub-action-ref.md)。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------

# 「Amazon S3 發佈」動作 YAML
<a name="s3-pub-action-ref"></a>

以下是 **Amazon S3 發佈**動作的 YAML 定義。若要了解如何使用此動作，請參閱 [使用工作流程將檔案發佈至 Amazon S3](s3-pub-action.md)。

此動作定義以區段的形式存在於更廣泛的工作流程定義檔案中。如需有關此檔案的詳細資訊，請參閱[工作流程 YAML 定義](workflow-reference.md)。

**注意**  
下列大多數 YAML 屬性在視覺化編輯器中都有對應的 UI 元素。若要查詢 UI 元素，請使用 **Ctrl\$1F**。 元素將與其相關聯的 YAML 屬性一起列出。

```
# The workflow definition starts here.
# See 最上層屬性 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  S3Publish\$1nn: 
    Identifier: aws/s3-publish@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      Sources:
        - source-name-1
      Artifacts:
        - artifact-name
      Variables:
        - Name: variable-name-1
          Value: variable-value-1
        - Name: variable-name-2
          Value: variable-value-2
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      SourcePath: my/source
      DestinationBucketName: amzn-s3-demo-bucket
      TargetPath: my/target
```

## S3Publish
<a name="s3.pub.name"></a>

(必要)

指定動作的名稱。工作流程中的所有動作名稱都必須是唯一的。動作名稱僅限於英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (\$1)。不允許空格。您無法使用引號在動作名稱中啟用特殊字元和空格。

預設：`S3Publish_nn`。

對應的 UI：組態索引標籤/**動作名稱**

## Identifier
<a name="s3.pub.identifier"></a>

(*S3Publish*/**Identifier**)

(必要)

識別 動作。除非您想要變更版本，否則請勿變更此屬性。如需詳細資訊，請參閱[指定要使用的動作版本](workflows-action-versions.md)。

預設：`aws/s3-publish@v1`。

對應的 UI：工作流程圖表/S3Publish\$1nn/**aws/s3-publish@v1** 標籤

## DependsOn
<a name="s3.pub.dependson"></a>

(*S3Publish*/**DependsOn**)

(選用)

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

如需 'depends on' 功能的詳細資訊，請參閱 [定序動作](workflows-depends-on.md)。

對應的 UI：輸入索引標籤/**取決於 - 選用**

## Compute
<a name="s3.pub.computename"></a>

(*S3Publish*/**Compute**)

(選用)

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

對應的 UI：*無*

## Type
<a name="s3.pub.computetype"></a>

(*S3Publish*/Compute/**Type**)

（如果[Compute](#s3.pub.computename)包含 則為必要）

運算引擎的類型。您可以使用下列其中一個值：
+ **EC2** （視覺化編輯器） 或 `EC2`(YAML 編輯器）

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

  最佳化動作啟動速度。

如需運算類型的更多相關資訊，請參閱[運算類型](workflows-working-compute.md#compute.types)。

對應的 UI：組態索引標籤/**運算類型**

## Fleet
<a name="s3.pub.computefleet"></a>

(*S3Publish*/Compute/**Fleet**)

(選用)

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

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

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

對應的 UI：組態索引標籤/**運算機群**

## Timeout
<a name="s3.pub.timeout"></a>

(*S3Publish*/**Timeout**)

(必要)

指定動作在 CodeCatalyst 結束動作之前可執行的時間，以分鐘為單位 (YAML 編輯器） 或小時和分鐘為單位。最小值為 5 分鐘，最大值如 中所述[CodeCatalyst 中工作流程的配額](workflows-quotas.md)。預設逾時與最大逾時相同。

對應的 UI：組態索引標籤/**逾時 - 選用 **

## Inputs
<a name="s3.pub.inputs"></a>

(*S3Publish*/**Inputs**)

(選用)

`Inputs` 區段定義工作流程執行期間 `S3Publish`所需的資料。

**注意**  
每個**AWS CDK 部署**動作最多允許四個輸入 （一個來源和三個成品）。變數不會計入此總計。

如果您需要參考位於不同輸入中的檔案 （例如來源和成品），則來源輸入是主要輸入，而成品是次要輸入。對次要輸入中檔案的參考需要特殊的字首，才能將其從主要輸入中消除。如需詳細資訊，請參閱[範例：參考多個成品中的檔案](workflows-working-artifacts-ex.md#workflows-working-artifacts-ex-ref-file)。

對應的 UI：**輸入**索引標籤

## Sources
<a name="s3.pub.inputs.sources"></a>

(*S3Publish*/Inputs/**Sources**)

（如果您要發佈至 Amazon S3 的檔案存放在來源儲存庫中，則為必要項目）

如果您要發佈至 Amazon S3 的檔案存放在來源儲存庫中，請指定該來源儲存庫的標籤。目前，唯一支援的標籤是 `WorkflowSource`。

如果您想要發佈至 Amazon S3 的檔案不包含在來源儲存庫中，它們必須位於另一個動作所產生的成品中。

如需來源的詳細資訊，請參閱 [將來源儲存庫連線至工作流程](workflows-sources.md)。

對應的 UI：輸入索引標籤/**來源 - 選用**

## Artifacts - input
<a name="s3.pub.inputs.artifacts"></a>

(*S3Publish*/Inputs/**Artifacts**)

（如果您要發佈至 Amazon S3 的檔案存放在先前動作的[輸出成品](workflows-working-artifacts-output.md)中，則為必要項目）

如果您想要發佈至 Amazon S3 的檔案包含在先前動作產生的成品中，請在此處指定該成品。如果您的檔案不包含在成品中，它們必須位於您的來源儲存庫中。

如需成品的詳細資訊，包括範例，請參閱 [在動作之間共用成品和檔案](workflows-working-artifacts.md)。

對應的 UI：組態索引標籤/**成品 - 選用**

## Variables - input
<a name="s3.pub.inputs.variables"></a>

(*S3Publish*/Inputs/**Variables**)

(選用)

指定名稱/值對的序列，以定義您要提供給動作的輸入變數。變數名稱僅限於英數字元 (a-z、A-Z、0-9)、連字號 (-) 和底線 (\$1)。不允許空格。您不能使用引號在變數名稱中啟用特殊字元和空格。

如需變數的詳細資訊，包括範例，請參閱 [在工作流程中使用變數](workflows-working-with-variables.md)。

對應的 UI：輸入索引標籤/**變數 - 選用**

## Environment
<a name="s3.pub.environment"></a>

(*S3Publish*/**Environment**)

(必要)

指定要與 動作搭配使用的 CodeCatalyst 環境。動作會連線至所選環境中指定的 AWS 帳戶 和選用 Amazon VPC。動作會使用環境中指定的預設 IAM 角色來連線至 AWS 帳戶，並使用 [Amazon VPC 連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)中指定的 IAM 角色來連線至 Amazon VPC。

**注意**  
如果預設 IAM 角色沒有 動作所需的許可，您可以將動作設定為使用不同的角色。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

如需環境的詳細資訊，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)和 [建立環境](deploy-environments-creating-environment.md)。

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

## Name
<a name="s3.pub.environment.name"></a>

(*S3Publish*/Environment/**Name**)

（如果[Environment](#s3.pub.environment)包含 則為必要）

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

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

## Connections
<a name="s3.pub.environment.connections"></a>

(*S3Publish*/Environment/**Connections**)

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

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

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

如需帳戶連線的詳細資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。如需將帳戶連線新增至環境的相關資訊，請參閱 [建立環境](deploy-environments-creating-environment.md)。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What*我的環境*是什麼？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Name
<a name="s3.pub.environment.connections.name"></a>

(*S3Publish*/Environment/Connections/**Name**)

（如果[Connections](#s3.pub.environment.connections)包含 則為必要）

指定帳戶連線的名稱。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**AWS account connection**

## Role
<a name="s3.pub.environment.connections.role"></a>

(*S3Publish*/Environment/Connections/**Role**)

（如果[Connections](#s3.pub.environment.connections)包含 則為必要）

指定 **Amazon S3 發佈**動作用來存取 AWS 和複製檔案至 Amazon S3 的 IAM 角色名稱。請確定您已[將角色新增至 CodeCatalyst 空間](ipa-connect-account-addroles.md)，且該角色包含下列政策。

如果您未指定 IAM 角色，則動作會使用 CodeCatalyst 主控台中[環境中](deploy-environments.md)列出的預設 IAM 角色。如果您在環境中使用預設角色，請確定其具有下列政策。
+ 下列許可政策：
**警告**  
將許可限制為下列政策中顯示的許可。使用具有更廣泛許可的角色可能會帶來安全風險。

------
#### [ JSON ]

****  

  ```
  {
      "Version":"2012-10-17",		 	 	 
      "Statement": [
          {
              "Sid": "VisualEditor0",
              "Effect": "Allow",
              "Action": [
                  "s3:PutObject",
                  "s3:ListBucket",
                  "s3:DeleteObject"
              ],
              "Resource": [
                  "arn:aws:s3:::bucket-name",
                  "arn:aws:s3:::bucket-name/*"
              ]
          }
      ]
  }
  ```

------
+ 下列自訂信任政策：

**注意**  
如有需要，您可以使用 `CodeCatalystWorkflowDevelopmentRole-spaceName`角色搭配此動作。如需有關此角色的詳細資訊，請參閱 [為您的帳戶和空間建立 **CodeCatalystWorkflowDevelopmentRole-*spaceName***角色](ipa-iam-roles.md#ipa-iam-roles-service-create)。了解該`CodeCatalystWorkflowDevelopmentRole-spaceName`角色具有可能造成安全風險的完整存取許可。我們建議您只在安全性較少的教學課程和案例中使用此角色。

對應的 UI：取決於動作版本，下列其中一項：
+ （較新版本） 組態tab/Environment/What是 *my-environment*？/三個點功能表/**切換角色**
+ （舊版本） 組態索引標籤/'Environment/account/role'/**Role**

## Configuration
<a name="s3.pub.configuration"></a>

(*S3Publish*/**Configuration**)

(必要)

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

對應的 UI：**組態**索引標籤

## SourcePath
<a name="s3.pub.source.directory"></a>

(*S3Publish*/Configuration/**SourcePath**)

(必要)

指定您要發佈至 Amazon S3 的目錄或檔案的名稱和路徑。目錄或檔案可以位於來源儲存庫或先前動作的成品中，並與來源儲存庫或成品根相關。

範例：

指定 會將 的內容`./myFolder/`複製到 `/myFolder` Amazon S3，並保留基礎目錄結構。

*僅*`myfile.txt`指定`./myFolder/myfile.txt`複本至 Amazon S3。（目錄結構已移除。)

您無法使用萬用字元。

**注意**  
您可能需要將字首新增至目錄或檔案路徑，以指出要在其中找到的成品或來源。如需詳細資訊，請參閱[參考來源儲存庫檔案](workflows-sources-reference-files.md)及[參考成品中的檔案](workflows-working-artifacts-refer-files.md)。

對應的 UI：組態索引標籤/**來源路徑**

## DestinationBucketName
<a name="s3.pub.dest.bucket"></a>

(*S3Publish*/Configuration/**DestinationBucketName**)

(必要)

指定您要發佈檔案的 Amazon S3 儲存貯體名稱。

對應的 UI：組態索引標籤/**目的地儲存貯體 - 選用**

## TargetPath
<a name="s3.pub.dest.directory"></a>

(*S3Publish*/Configuration/**TargetPath**)

(選用)

在 Amazon S3 中指定您要發佈檔案的目錄名稱和路徑。如果目錄不存在，則會建立該目錄。目錄路徑不得包含儲存貯體名稱。

範例：

`myS3Folder`

`./myS3Folder/myS3Subfolder`

對應的 UI：組態索引標籤/**目的地目錄 - 選用**

# 部署至 AWS 帳戶 和 VPCs
<a name="deploy-environments"></a>

使用 [CodeCatalyst 工作流程](workflow.md)，您可以部署應用程式和其他資源以鎖定 AWS 雲端中的 AWS 帳戶和 Amazon VPCs。若要啟用這些部署，您必須設定 CodeCatalyst 環境。

CodeCatalyst *環境*，不與[開發環境](https://docs.aws.amazon.com/codecatalyst/latest/userguide/devenvironment.html)混淆，定義 CodeCatalyst [工作流程](workflow.md)連線的目標 AWS 帳戶 和選用 Amazon VPC。環境也會定義工作流程存取目標帳戶中 AWS 的服務和資源所需的 [IAM 角色](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)。

您可以設定多個環境並為其命名，例如開發、測試、預備和生產等名稱。當您部署到這些環境中時，有關部署的資訊會顯示於環境中的 CodeCatalyst **部署活動**和**部署目標**標籤上。

## 如何開始使用環境？
<a name="deploy-environments-get-started"></a>

新增和使用 CodeCatalyst 環境的高階步驟如下：

1. 在您的 CodeCatalyst 空間中，**連接一或多個 AWS 帳戶**。在此程序中，新增工作流程存取 中資源所需的 IAM 角色 AWS 帳戶。如需詳細資訊，請參閱[允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。

1. 在 CodeCatalyst 專案中，**建立包含步驟 1 中其中一個 和 IAM 角色的環境**。 AWS 帳戶如需詳細資訊，請參閱[建立環境](deploy-environments-creating-environment.md)。

1. 在 CodeCatalyst 專案的工作流程中，**新增指向您在步驟 2 中所建立環境[的動作](workflows-actions.md)**。如需詳細資訊，請參閱[將動作新增至工作流程](workflows-add-action.md)。

   您現在已設定環境。動作現在可以將資源部署到環境中 AWS 帳戶 指定的 。

**注意**  
您也可以將 Amazon VPC 新增至環境。如需詳細資訊，請參閱 *CodeCatalyst 管理指南*中的[新增空間的 VPC 連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)和 [將 VPC 與環境建立關聯](deploy-environments-associate-vpc.md)。

## 單一工作流程中可以存在多個環境嗎？
<a name="deploy-environments-multiple"></a>

是。如果工作流程包含多個動作，則可以為每個動作指派一個環境。例如，您可以有一個工作流程，其中包含兩個部署動作，其中一個指派`my-staging-enviroment`環境，另一個指派`my-production-environment`環境。

## 哪些工作流程動作支援環境？
<a name="deploy-environments-supported"></a>

將資源部署到 AWS 雲端，或基於其他原因 （例如監控和報告） 與 AWS 服務通訊的任何工作流程動作都支援環境。

## 哪些動作支援在 CodeCatalyst 中顯示其部署資訊？
<a name="deploy-environments-supported-targets"></a>

在支援環境的工作流程動作中，只有少數支援將其部署資訊顯示在 CodeCatalyst 主控台的**部署活動**和**部署目標**頁面上。

下列工作流程動作支援顯示其部署資訊：
+ **部署 CloudFormation 堆疊** – 如需詳細資訊，請參閱 [部署 CloudFormation 堆疊](deploy-action-cfn.md)
+ **部署至 Amazon ECS** – 如需詳細資訊，請參閱 [使用工作流程部署至 Amazon ECS](deploy-action-ecs.md)
+ **部署至 Kubernetes 叢集** – 如需詳細資訊，請參閱 [使用工作流程部署至 Amazon EKS](deploy-action-eks.md)
+ **AWS CDK 部署** – 如需詳細資訊，請參閱 [使用工作流程部署 AWS CDK 應用程式](cdk-dep-action.md)

## 支援的區域
<a name="deploy-environments-supported-regions"></a>

**環境**頁面可以顯示任何 AWS 區域中的資源。

## 環境是強制性的嗎？
<a name="deploy-environments-optional-or-mandatory"></a>

如果獲指派的工作流程動作將資源部署到 AWS 雲端，或基於其他原因 （例如監控和報告） 與 AWS 服務通訊，則環境為強制性。

例如，如果您有一個建置動作來建置應用程式，但不需要與您的 AWS 帳戶 或 Amazon VPC 通訊，則不需要將環境指派給動作。不過，如果建置動作將日誌傳送至 中的 Amazon CloudWatch 服務 AWS 帳戶，則動作必須指派環境。

**Topics**
+ [如何開始使用環境？](#deploy-environments-get-started)
+ [單一工作流程中可以存在多個環境嗎？](#deploy-environments-multiple)
+ [哪些工作流程動作支援環境？](#deploy-environments-supported)
+ [哪些動作支援在 CodeCatalyst 中顯示其部署資訊？](#deploy-environments-supported-targets)
+ [支援的區域](#deploy-environments-supported-regions)
+ [環境是強制性的嗎？](#deploy-environments-optional-or-mandatory)
+ [建立環境](deploy-environments-creating-environment.md)
+ [將環境與 動作建立關聯](deploy-environments-add-app-to-environment.md)
+ [將 VPC 與環境建立關聯](deploy-environments-associate-vpc.md)
+ [將 AWS 帳戶 與 環境建立關聯](deploy-environments-associate-account.md)
+ [變更 動作的 IAM 角色](deploy-environments-switch-role.md)

# 建立環境
<a name="deploy-environments-creating-environment"></a>

使用以下指示來建立您稍後可以與工作流程動作建立關聯的環境。

**開始之前**

您需要下列項目：
+ CodeCatalyst 空間。如需詳細資訊，請參閱[設定並登入 CodeCatalyst設定並登入 CodeCatalyst](setting-up-topnode.md)。
+ CodeCatalyst 專案。如需詳細資訊，請參閱[使用藍圖建立專案](projects-create.md#projects-create-console-template)。
+  AWS 帳戶連線，其中包含工作流程動作需要存取的 IAM 角色 AWS。如需建立帳戶連線的資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。每個環境最多只能使用一個帳戶連線。
**注意**  
您可以建立沒有帳戶連線的環境；不過，稍後需要返回並新增連線。
+ 下列其中一個 CodeCatalyst 角色：
  + **空間管理員**
  + **專案管理員**
  + **Contributor (作者群)**
**注意**  
如果您有 **Contributor 角色**，您可以建立環境，但無法將其與 AWS 帳戶 連線建立關聯。您需要要求具有 **Space 管理員**或**專案管理員**角色的人員將環境與 AWS 帳戶 連線建立關聯。

   如需許可和角色的詳細資訊，請參閱 [授予使用者專案許可](projects-members.md)。

**建立環境**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**環境**。

1. 在**環境名稱**中，輸入名稱，例如 **Production**或 **Staging**。

1. 在**環境類型**中，選取下列其中一項：
   + **非生產** – 在將應用程式移至生產環境之前，您可以測試應用程式以確保其如預期般運作的環境。
   + **生產** – 可公開取得並託管您完成之應用程式的「即時」環境。

     如果您選擇**生產**，**生產**徽章會顯示在 UI 中與環境相關聯的任何動作旁。徽章有助於您快速查看目前哪些動作正在部署到生產中。除了徽章的外觀之外，生產環境和非生產環境之間沒有差異。

1. （選用） 在**描述**中，輸入描述，例如 **Production environment for the hello-world app**。

1. 在**AWS 帳戶 連線中 - 選用**，選擇您要與此環境建立關聯的 AWS 帳戶連線。指派給此環境的工作流程動作將能夠連線至相關聯的 AWS 帳戶。如需在 CodeCatalyst 中建立 AWS 帳戶 連線的詳細資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。

   如果您想要使用的 AWS 帳戶 連線未列出，可能是因為您的專案中不允許。如需詳細資訊，請參閱《*Amazon CodeCatalyst 管理員指南*》中的[設定專案限制帳戶連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-accounts-restriction.html)。

1. 在**預設 IAM 角色**中，選擇您要與此環境建立關聯的 IAM 角色。指派給此環境的工作流程動作會繼承此 IAM 角色，並能夠用來連線到 中的 服務和資源 AWS 帳戶。

   如果您需要將環境指派給多個動作，而且這些動作需要與此處指定的預設角色不同的 IAM 角色，則可以使用切換角色選項，在每個動作的**組態**索引標籤上指定不同的角色。 ****如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

   如果您想要用作預設值的 IAM 角色未列出，可能是因為您尚未將其新增至 AWS 帳戶 連線。若要將 IAM 角色新增至帳戶連線，請參閱 [新增 IAM 角色至帳戶連線](ipa-connect-account-addroles.md)。

1. （選用） 在 **VPC 連線**中，選擇您要與此環境建立關聯的 VPC 連線。如需建立 VPC 連線的詳細資訊，請參閱[《Amazon CodeCatalyst 管理員指南》中的管理 Amazon Virtual Private Clouds](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.html)。 * CodeCatalyst *

   如果您想要使用的 VPC 連線未列出，可能是因為其中包含專案中不允許的 AWS 帳戶 連線。如需詳細資訊，請參閱《*Amazon CodeCatalyst 管理員指南*》中的[設定專案限制帳戶連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-accounts-restriction.html)。

1. 選擇 **Create environment** (建立環境)。CodeCatalyst 會建立空的環境。

**後續步驟**
+ 現在您已建立環境，即可將其與工作流程動作建立關聯。如需詳細資訊，請參閱[將環境與 動作建立關聯](deploy-environments-add-app-to-environment.md)。

# 將環境與 動作建立關聯
<a name="deploy-environments-add-app-to-environment"></a>

當您將環境與[支援的工作流程動作](deploy-environments.md#deploy-environments-supported)建立關聯時，環境的預設 AWS 帳戶 IAM 角色和選用的 Amazon VPC 會指派給動作。然後， 動作可以使用 IAM 角色來連接和部署到 AWS 帳戶 ，也可以連接到選用的 Amazon VPC。

使用以下指示，將環境與 動作建立關聯。

## 步驟 1：將環境與工作流程動作建立關聯
<a name="deploy-environments-add-app-to-environment-assoc"></a>

使用下列程序將環境與工作流程動作建立關聯。

------
#### [ Visual ]

**使用視覺化編輯器將環境與工作流程動作建立關聯**

1. 開啟 CodeCatalyst 主控台，網址為 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/)。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇**視覺化**。

1. 在工作流程圖表中，選擇環境支援的動作。如需詳細資訊，請參閱[哪些動作支援在 CodeCatalyst 中顯示其部署資訊？](deploy-environments.md#deploy-environments-supported-targets)。

1. 選擇**組態**索引標籤，然後在**環境**欄位中指定資訊，如下所示。

   **Environment (環境)** 

   指定要與 動作搭配使用的 CodeCatalyst 環境。動作會連線至所選環境中指定的 AWS 帳戶 和選用 Amazon VPC。動作會使用環境中指定的預設 IAM 角色來連線至 AWS 帳戶，並使用 [Amazon VPC 連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html)中指定的 IAM 角色來連線至 Amazon VPC。
**注意**  
如果預設 IAM 角色沒有 動作所需的許可，您可以將 動作設定為使用不同的角色。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

   如需環境的詳細資訊，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)和 [建立環境](deploy-environments-creating-environment.md)。

1. （選用） 變更與動作相關聯的 IAM 角色。如果角色包含動作的錯誤許可集，您可能想要變更角色。

    若要變更角色：

   1. 在***我的環境中*是什麼？** 方塊，然後選擇垂直省略符號圖示 (![\[Ellipsis.\]](http://docs.aws.amazon.com/zh_tw/codecatalyst/latest/userguide/images/flows/elipsis.png))。

   1. 選擇下列其中一項：
      +  **切換角色**。選擇此選項可變更此動作所使用的 IAM 角色，且僅變更此動作。其他動作會繼續使用其相關聯環境中指定的預設 IAM 角色。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。
      +  **編輯環境**。選擇此選項可變更您環境中列出的預設 IAM 角色。當您選擇此選項時，您的動作以及與相同環境相關聯的任何其他動作都會開始使用新的預設 IAM 角色。
**重要**  
更新預設 IAM 角色時請小心。如果角色中的許可不足以用於共用環境的所有動作，變更角色可能會導致動作失敗。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------
#### [ YAML ]

**使用 YAML 編輯器將環境與工作流程動作建立關聯**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在您要與環境建立關聯的工作流程動作中，新增類似下列的程式碼：

   ```
   action-name:
     Environment:
       Name: environment-name
   ```

   如需詳細資訊，請參閱 [動作類型](workflows-actions.md#workflows-actions-types)主題。本主題包含每個動作的文件連結，包括其 YAML 參考。

1. （選用） 如果您想要動作使用與環境中列出的預設 IAM 角色不同的角色，請新增包含您要使用之角色的`Connections:`區段。如需詳細資訊，請參閱[變更 動作的 IAM 角色](deploy-environments-switch-role.md)。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------

## 步驟 2：填入部署活動頁面
<a name="deploy-environments-add-app-to-environment-run"></a>

將環境與工作流程動作建立關聯後，您可以在 CodeCatalyst 主控台**的環境**區段中，將部署資訊填入部署**活動**和部署**目標**頁面。使用下列指示來填入這些頁面。

**注意**  
只有幾個動作支援在 CodeCatalyst 主控台中顯示其部署資訊。如需詳細資訊，請參閱[哪些動作支援在 CodeCatalyst 中顯示其部署資訊？](deploy-environments.md#deploy-environments-supported-targets)。

**將部署資訊新增至 CodeCatalyst**

1. 如果您在 中遞交變更時，工作流程執行未自動啟動[步驟 1：將環境與工作流程動作建立關聯](#deploy-environments-add-app-to-environment-assoc)，請手動啟動執行，如下所示：

   1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

   1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

   1. 選擇**執行**。

   工作流程執行會啟動新的部署，這會導致 CodeCatalyst 將部署資訊新增至 CodeCatalyst。

1. 確認部署活動已新增至 CodeCatalyst 主控台：

   1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**環境**。

   1. 選擇您的環境 （例如 `Production`)。

   1. 選擇**部署活動**索引標籤，並確認部署顯示為 **SUCCEEDED** **狀態**。這表示工作流程執行成功部署您的應用程式資源。

   1. 選擇**部署目標**索引標籤，並確認您的應用程式資源是否出現。

# 將 VPC 與環境建立關聯
<a name="deploy-environments-associate-vpc"></a>

使用具有 VPC 連線的環境設定動作時，該動作將執行連線至 VPC，遵守網路規則並存取相關聯 VPC 指定的資源。一個或多個環境可以使用相同的 VPC 連線。

使用下列指示將 VPC 連線與 環境建立關聯。

**將 VPC 連線與環境建立關聯**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**環境**。

1. 選擇您的環境 （例如 `Production`)。

1. 選擇**環境屬性**索引標籤。

1. 選擇**管理 VPC 連線**，選擇所需的 VPC 連線，然後選擇**確認**。這會將您選取的 VPC 連線與此環境建立關聯。
**注意**  
如果您想要使用的 VPC 連線未列出，可能是因為其中包含專案中不允許的 AWS 帳戶 連線。如需詳細資訊，請參閱《*Amazon CodeCatalyst 管理員指南*》中的[設定專案限制帳戶連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-accounts-restriction.html)。

如需詳細資訊，請參閱 *CodeCatalyst 管理員指南*中的[管理 Amazon Virtual Private Cloud](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.html)。

# 將 AWS 帳戶 與 環境建立關聯
<a name="deploy-environments-associate-account"></a>

使用以下指示，將 AWS 帳戶 與 環境建立關聯。當您將 AWS 帳戶 與 環境建立關聯時，指派給環境的工作流程動作將能夠連線到 AWS 帳戶。

如需帳戶連線的詳細資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。

**開始之前**

您需要下列項目：
+  AWS 帳戶連線，其中包含工作流程動作需要存取的 IAM 角色 AWS。如需建立帳戶連線的資訊，請參閱 [允許存取已連線 AWS 的資源 AWS 帳戶](ipa-connect-account.md)。每個環境最多只能使用一個帳戶連線。
+ 下列其中一個 CodeCatalyst 角色：**空間管理員**或**專案管理員**。如需詳細資訊，請參閱[授予使用者專案許可](projects-members.md)。

**將 AWS 帳戶 與 環境建立關聯**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**環境**。

1. 選擇您的環境 （例如 `Production`)。

1. 選擇**編輯環境**。

1. 在**環境屬性**下，於**AWS 帳戶 連線 - 選用**下拉式清單中，選擇所需的 AWS 帳戶。

   如果您想要使用的 AWS 帳戶 連線未列出，可能是因為您的專案中不允許。如需詳細資訊，請參閱《*Amazon CodeCatalyst 管理員指南*》中的[設定專案限制帳戶連線](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-accounts-restriction.html)。

1. 在**預設 IAM 角色**中，選擇您要與此環境建立關聯的 IAM 角色。指派給此環境的工作流程動作會繼承此 IAM 角色，並能夠用來連線至 中的 服務和資源 AWS 帳戶。

   如果您想要用作預設值的 IAM 角色未列出，可能是因為您尚未將其新增至 AWS 帳戶 連線。若要將 IAM 角色新增至帳戶連線，請參閱 [新增 IAM 角色至帳戶連線](ipa-connect-account-addroles.md)。

# 變更 動作的 IAM 角色
<a name="deploy-environments-switch-role"></a>

根據預設，當您將[環境](deploy-environments.md)與工作流程[動作](workflows-actions.md)建立關聯時，動作會繼承環境中指定的預設 IAM 角色。您可以變更此行為，讓動作使用不同的角色。如果預設 IAM 角色缺少動作在 AWS 雲端中操作所需的許可，您可能會希望動作使用不同的角色。

若要將不同的 IAM 角色指派給動作，您可以在視覺化編輯器中使用**切換角色**選項，或在 YAML 編輯器中使用 `Connections:` 屬性。新角色會覆寫環境中指定的預設 IAM 角色，讓您將預設 IAM 角色保持原狀。如果有其他動作使用預設 IAM 角色，建議您保持原狀。

使用下列指示來設定 動作，以使用與其環境中指定的 IAM 角色不同的 IAM 角色。

------
#### [ Visual ]

**將不同的 IAM 角色指派給動作 （視覺化編輯器）**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇代表您要更新其 IAM 角色之動作的方塊。

1. 選擇 **Configuration** (組態) 索引標籤。

1. 在***我的環境中*是什麼？** 方塊，選擇垂直省略號圖示 (![\[Ellipsis.\]](http://docs.aws.amazon.com/zh_tw/codecatalyst/latest/userguide/images/flows/elipsis.png))。

1. 選擇**切換角色**。

1. 在**切換角色**對話方塊中的 **IAM 角色**下拉式清單中，選擇您要動作使用的 IAM 角色。此角色會覆寫環境中的預設 IAM 角色。如果您想要使用的角色不在清單中，請確定您已將其新增至您的空間。如需詳細資訊，請參閱[新增 IAM 角色至帳戶連線](ipa-connect-account-addroles.md)。

   所選角色現在會出現在***我的環境中*的內容中？** 方塊，以及**工作流程徽章中定義的** 。該角色也會出現在 `Connections:`區段的工作流程定義檔案中。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

------
#### [ YAML ]

**將不同的 IAM 角色指派給動作 (YAML 編輯器）**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**編輯**。

1. 選擇 **YAML**。

1. 在您想要使用不同 IAM 角色的工作流程動作中，新增 `Connections:`區段，如下所示：

   ```
   action-name:
     Environment:
       Name: environment-name
       Connections: 
         - Name: account-connection-name
           Role: iam-role-name
   ```

   在上述程式碼中，將 *account-connection-name* 取代為包含 IAM 角色[的帳戶連線](ipa-connect-account.md)名稱，並將 *iam-role-name* 取代為您希望動作使用的 IAM 角色名稱。此角色會覆寫環境中的預設 IAM 角色。請確定您已將 角色新增至您的空間。如需詳細資訊，請參閱[新增 IAM 角色至帳戶連線](ipa-connect-account-addroles.md)。

   如需詳細資訊，請參閱 [動作類型](workflows-actions.md#workflows-actions-types)主題。本主題包含每個動作的文件連結，包括其 YAML 參考。

------

# 在工作流程圖表中顯示應用程式 URL
<a name="deploy-app-url"></a>

如果您的工作流程部署應用程式，您可以設定 Amazon CodeCatalyst，將應用程式的 URL 顯示為可點選的連結。此連結會出現在 CodeCatalyst 主控台的部署動作內。下列工作流程圖表顯示出現在動作底部的**檢視應用程式** URL。

![\[檢視應用程式 URL\]](http://docs.aws.amazon.com/zh_tw/codecatalyst/latest/userguide/images/deploy/view-app-url.png)


透過在 CodeCatalyst 主控台中啟用此 URL，您可以快速驗證應用程式部署。

**注意**  
**部署至 Amazon ECS **動作不支援應用程式 URL。

若要啟用此功能，請使用包含 `appurl`或 的名稱，將輸出變數新增至您的動作`endpointurl`。您可以使用有或沒有聯結破折號 (`-`)、底線 (`_`) 或空格 () 的名稱` `。字串不區分大小寫。將變數的值設定為已部署應用程式的 `http`或 `https` URL。

**注意**  
如果您要更新現有的輸出變數以包含 `app url`或 `endpoint url`字串，請更新此變數的所有參考，以使用新的變數名稱。

如需詳細步驟，請參閱下列其中一個程序：
+ [在「AWS CDK 部署」動作中顯示應用程式 URL](#deploy-app-url-cdk)
+ [在「部署 CloudFormation 堆疊」動作中顯示應用程式 URL](#deploy-app-url-cfn)
+ [在所有其他動作中顯示應用程式 URL](#deploy-app-url-other)

當您完成設定 URL 後，請依照下列指示確認 URL 是否如預期顯示：
+ [驗證已新增應用程式 URL](#deploy-app-url-verify)<a name="deploy-app-url-cdk"></a>

**在「AWS CDK 部署」動作中顯示應用程式 URL**

1. 如果您使用的是**AWS CDK 部署**動作，請在 AWS CDK 應用程式程式碼中新增建構 `CfnOutput` （即索引鍵/值對）：
   + 索引鍵名稱必須包含 `appurl`、 或 `endpointurl`，包含或不包含聯結破折號 (`-`)、底線 (`_`) 或空格 ()` `。字串不區分大小寫。
   + 值必須是已部署應用程式的 `http`或 `https` URL。

   例如，您的 AWS CDK 程式碼可能如下所示：

   ```
   import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
   import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
   import * as s3 from 'aws-cdk-lib/aws-s3';
   import { Construct } from 'constructs';
   import * as cdk from 'aws-cdk-lib';
   export class HelloCdkStack extends Stack {
     constructor(scope: Construct, id: string, props?: StackProps) {
       super(scope, id, props);
       const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
         removalPolicy: RemovalPolicy.DESTROY,
       });
       new CfnOutput(this, 'APP-URL', {
         value: https://mycompany.myapp.com,
         description: 'The URL of the deployed application',
         exportName: 'myApp',
       });
       ...
     }
   }
   ```

   如需建構模組的詳細資訊，請參閱 API `CfnOutput` 參考中的[界面 CfnOutputProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnOutputProps.html)。 *AWS Cloud Development Kit (AWS CDK) *

1. 儲存並遞交您的程式碼。

1. 繼續執行「[驗證已新增應用程式 URL](#deploy-app-url-verify)」。<a name="deploy-app-url-cfn"></a>

**在「部署 CloudFormation 堆疊」動作中顯示應用程式 URL**

1. 如果您使用的是**部署 CloudFormation 堆疊**動作，請將輸出新增至 CloudFormation 範本或 AWS SAM 範本中具有下列特性的 `Outputs`區段：
   + 金鑰 （也稱為邏輯 ID) 必須包含 `appurl`、 或 `endpointurl`，包含或不包含聯結破折號 (`-`)、底線 (`_`) 或空格 ()` `。字串不區分大小寫。
   + 值必須是已部署應用程式的 `http`或 `https` URL。

   例如，您的 CloudFormation 範本可能如下所示：

   ```
   "Outputs" : {
     "APP-URL" : {
       "Description" : "The URL of the deployed app",
       "Value" : "https://mycompany.myapp.com",
       "Export" : {
         "Name" : "My App"
       }
     }
   }
   ```

   如需 CloudFormation 輸出的詳細資訊，請參閱*AWS CloudFormation *[《 使用者指南》中的輸出](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html)。

1. 儲存並遞交您的程式碼。

1. 繼續執行「[驗證已新增應用程式 URL](#deploy-app-url-verify)」。<a name="deploy-app-url-other"></a>

**在所有其他動作中顯示應用程式 URL**

如果您使用另一個動作來部署應用程式，例如建置動作或 **GitHub 動作**，請執行下列動作以顯示應用程式 URL。

1. 在工作流程定義檔案中 動作的 `Inputs`或 `Steps`區段中定義環境變數。變數必須具有下列特性：
   + `name` 必須包含 `appurl`、 或 `endpointurl`，包含或不包含聯結破折號 (`-`)、底線 (`_`) 或空格 ()` `。字串不區分大小寫。
   + 值必須是已部署應用程式的 `http`或 `https` URL。

   例如，建置動作可能如下所示：

   ```
   Build-action:
     Identifier: aws/build@v1
     Inputs:
       Variables:
         - Name: APP-URL
           Value: https://mycompany.myapp.com
   ```

   ...或此項目：

   ```
   Actions:
     Build:
       Identifier: aws/build@v1
       Configuration:    
         Steps:
           - Run: APP-URL=https://mycompany.myapp.com
   ```

   如需定義環境變數的詳細資訊，請參閱 [定義變數](workflows-working-with-variables-define-input.md)。

1. 匯出 變數。

   例如，您的建置動作可能如下所示：

   ```
   Build-action:
     ...
     Outputs:
       Variables:
         - APP-URL
   ```

   如需匯出變數的詳細資訊，請參閱 [匯出變數，讓其他動作可以使用它](workflows-working-with-variables-export-input.md)。

1. （選用） 選擇**驗證**以在遞交之前驗證工作流程的 YAML 程式碼。

1. 選擇**遞交**，輸入遞交訊息，然後再次選擇**遞交**。

1. 繼續執行「[驗證已新增應用程式 URL](#deploy-app-url-verify)」。<a name="deploy-app-url-verify"></a>

**驗證已新增應用程式 URL**
+ 如果工作流程尚未自動啟動，請啟動工作流程執行。新執行應該在其工作流程圖表中將應用程式 URL 顯示為可點選連結。如需啟動執行的詳細資訊，請參閱 [手動啟動工作流程執行](workflows-manually-start.md)。

# 移除部署目標
<a name="deploy-remove-target"></a>

您可以從 CodeCatalyst 主控台的部署目標頁面移除**部署目標**，例如 Amazon ECS 叢集或 CloudFormation 堆疊。

**重要**  
當您移除部署目標時，該目標會從 CodeCatalyst 主控台中移除，但在託管目標 AWS 的服務中仍然可用 （如果仍然存在）。

如果目標在 CodeCatalyst 中過時，請考慮移除部署目標。在以下情況下，目標可能會過時：
+ 您已刪除部署到目標的工作流程。
+ 您已變更要部署的堆疊或叢集。
+ 您已從 主控台的 CloudFormation 或 Amazon ECS 服務 AWS 中刪除堆疊或叢集。

**移除部署目標**

1. 開啟 CodeCatalyst 主控台，網址為 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/)。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**環境**。

1. 選擇包含您要移除之部署目標的環境名稱。如需環境的相關資訊，請參閱 [部署至 AWS 帳戶 和 VPCs](deploy-environments.md)。

1. 選擇**部署目標**索引標籤。

1. 選擇您要移除之部署目標旁的選項按鈕。

1. 選擇**移除**。

   目標會從頁面中移除。

# 依遞交追蹤部署狀態
<a name="track-changes"></a>

在開發生命週期的任何時候，請務必了解特定遞交的部署狀態，例如錯誤修正、新功能或其他有影響力的變更。請考慮下列部署狀態追蹤功能對開發團隊有幫助的案例：
+ 身為開發人員，您已修正 以解決錯誤，並想要報告其在團隊部署環境中的部署狀態。
+ 身為發行管理員，您想要檢視已部署遞交的清單，以追蹤和報告其部署狀態。

CodeCatalyst 提供檢視，可讓您快速判斷個別遞交或變更的部署位置，以及部署到哪個環境。此檢視包括：
+ 遞交的清單。
+ 包含遞交的部署狀態。
+ 成功部署遞交的環境。
+ 任何測試的狀態會針對 CI/CD 工作流程中的遞交執行。

下列程序詳細說明如何導覽至 ，並使用此檢視來追蹤專案中的變更。

**注意**  
僅 [CodeCatalyst 儲存庫](source.md)支援依遞交追蹤部署狀態。您無法將此功能與 [GitHub 儲存庫、Bitbucket 儲存庫或 GitLab 專案儲存庫](extensions.md)搭配使用。

**依遞交追蹤部署狀態**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**變更追蹤**。

1. 在主窗格頂端的兩個下拉式清單中，選擇包含您要檢視其發行狀態之遞交的來源儲存庫和分支。

1. 選擇**檢視變更**。

   遞交清單隨即出現。

   對於每個遞交，您可以檢視下列項目：
   + 遞交資訊，例如 ID、作者、訊息以及遞交時間。如需詳細資訊，請參閱[將程式碼與 CodeCatalyst 中的來源儲存庫一起存放和協作儲存程式碼並與來源儲存庫協作](source.md)。
   + 每個環境的部署狀態。如需詳細資訊，請參閱[部署至 AWS 帳戶 和 VPCs](deploy-environments.md)。
   + 測試和程式碼涵蓋範圍結果。如需詳細資訊，請參閱[使用工作流程進行測試使用工作流程進行測試](test-workflow-actions.md)。
**注意**  
軟體合成分析 (SCA) 結果不會顯示。

1. （選用） 若要檢視與特定遞交相關的變更的詳細資訊，包括最新的部署和詳細的程式碼涵蓋範圍和單位測試資訊，請選擇**檢視該遞交的詳細資訊**。

# 檢視部署日誌
<a name="deploy-deployment-logs"></a>

您可以檢視與特定部署動作相關的日誌，以疑難排解 Amazon CodeCatalyst 中的問題。

您可以檢視從[工作流程](workflow.md)或[環境](deploy-environments.md)開始的日誌。

**從工作流程開始檢視部署動作的日誌**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 選擇**執行**。

1. 選擇部署您應用程式的工作流程執行。

1. 在工作流程圖表中，選擇您要檢視其日誌的動作。

1. 選擇**日誌**索引標籤並展開區段，以顯示日誌訊息。

1. 若要檢視更多日誌，請選擇**摘要**索引標籤，然後選擇在 ** CloudFormation 中檢視** （如果有的話） 以檢視更多日誌。您可能需要登入 AWS。

**從 環境開始檢視部署動作的日誌**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**環境**。

1. 選擇部署應用程式的環境。

1. 在**部署活動中**，尋找**工作流程執行 ID** 欄，然後選擇部署堆疊的工作流程執行。

1. 在工作流程圖表中，選擇您要檢視其日誌的動作。

1. 選擇**日誌**索引標籤並展開區段以顯示日誌訊息。

1. 若要檢視更多日誌，請選擇**摘要**索引標籤，然後選擇 ** CloudFormation 中的檢視** （如果有的話） 來檢視更多日誌。您可能需要登入 AWS。

# 檢視部署資訊
<a name="deploy-view-deployment-info"></a>

您可以在 Amazon CodeCatalyst 中檢視部署的下列相關資訊：
+ 部署活動，包括部署狀態、開始時間、結束時間、歷史記錄和事件持續時間。
+ 堆疊名稱 AWS 區域、上次更新時間和相關聯的工作流程。
+ 遞交和提取請求。
+ 動作特定資訊，例如 CloudFormation 事件和輸出。

您可以檢視從[工作流程](workflow.md)、[環境](deploy-environments.md)或工作流程[動作](workflows-concepts.md#workflows-concepts-actions)開始的部署資訊。

**從工作流程開始檢視部署資訊**
+ 前往部署您應用程式的工作流程執行。如需說明，請參閱[檢視工作流程執行狀態和詳細資訊](workflows-view-run.md)。

**從 環境開始檢視部署資訊**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**環境**。

1. 選擇部署堆疊的環境，例如 `Production`。

1. 選擇**部署活動**以檢視堆疊的部署歷史記錄、部署狀態 （例如 **SUCCEEDED **或 **FAILED**)，以及其他部署相關資訊。

1. 選擇**部署目標**以檢視部署到環境中的堆疊、叢集或其他目標的相關資訊。您可以檢視堆疊名稱、區域、提供者和識別符等資訊。

**從 動作開始檢視部署資訊**

1. 在 https：//[https://codecatalyst.aws/](https://codecatalyst.aws/) 開啟 CodeCatalyst 主控台。

1. 選擇您的專案。

1. 在導覽窗格中，選擇 **CI/CD**，然後選擇**工作流程**。

1. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選，或依工作流程名稱或狀態進行篩選。

1. 在工作流程圖表中，選擇部署應用程式的工作流程動作。例如，您可以選擇 **DeployCloudFormationStack**。

1. 檢閱右側窗格中的內容，以取得動作特定的部署資訊。