「部署 AWS CloudFormation 堆疊」動作 YAML

以下是「部署 AWS CloudFormation 堆疊」動作的YAML定義。若要瞭解如何使用此動作，請參閱部署 AWS CloudFormation 堆疊。

此動作定義存在於更廣泛的工作流程定義檔案中的區段。如需有關此檔案的詳細資訊，請參閱工作流程YAML定義。

注意

接下來的大多數YAML屬性在可視化編輯器中都具有相應的 UI 元素。若要查詢使用者介面元素，請使用 Ctrl+F。元素將與其關聯的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-z、A-Z、0-9)、連字號 (-) 和底線 (_)。不允許空格。您無法使用引號來啟用動作名稱中的特殊字元和空格。

預設：DeployCloudFormationStack_nn。

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

Identifier

(DeployCloudFormationStack/Identifier)

(必要)

識別動作。除非您要變更版本，否則請勿變更此屬性。如需詳細資訊，請參閱指定要使用的動作版本。

預設：aws/cfn-deploy@v1。

對應的使用者介面：工作流程圖/DeployCloudFormationStack_nn/ aws/cfn-部署@v1 標籤

DependsOn

(DeployCloudFormationStack/DependsOn)

(選用)

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

如需有關「依賴」功能的詳細資訊，請參閱。定序動作

對應的用戶界面：輸入選項卡/取決於- 可選

Compute

(DeployCloudFormationStack/Compute)

(選用)

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

對應的用戶界面：無

Type

(DeployCloudFormationStack/Compute/Type)

（如果包含Compute，則為必填）

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

EC2（可視化編輯器）或EC2（YAML編輯器）

針對動作執行期間的彈性進行優化
Lambda（可視化編輯器）或Lambda（YAML編輯器）

最佳化動作啟動速度。

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

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

Fleet

(DeployCloudFormationStack/Compute/Fleet)

(選用)

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

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

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

對應的使用者介面：組態索引標籤/進階-選用/運算叢集

Timeout

(DeployCloudFormationStack/Timeout)

(選用)

指定動作在 CodeCatalyst 結束動作之前可執行的時間長度 (以分鐘為單位) 或小時和分鐘 (視覺化編輯器)。YAML最小值為 5 分鐘，最大值在中說明中的工作流程配額 CodeCatalyst。預設逾時與逾時上限相同。

對應的 UI：配置選項卡/超時（分鐘）- 可選

Environment

(DeployCloudFormationStack/Environment)

(必要)

指定要與動作搭配使用的 CodeCatalyst 環境。該動作連接到所選環境中VPC指定的 AWS 帳戶和可選的 Amazon。該動作使用環境中指定的預設IAM角色連接到 AWS 帳戶，並使用 Amazon VPC 連接中指定的IAM角色連接到 Amazon VPC。

注意

如果預設IAM角色沒有動作所需的權限，您可以將動作配置為使用其他角色。如需詳細資訊，請參閱變更動作IAM的角色。

若要取得有關環境的更多資訊，請參閱部署至 AWS 帳戶和 VPCs和建立環境。

對應的 UI：配置選項卡/環境

Name

(DeployCloudFormationStack/Environment/Name)

（如果包含Environment，則為必填）

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

對應的 UI：配置選項卡/環境

Connections

(DeployCloudFormationStack/Environment/Connections)

(在較新版本的動作中為選用項目；舊版本為必要)

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

如果您未指定帳戶連線：

此動作會使用在 CodeCatalyst 主控台環境中指定的 AWS 帳戶連線和預設IAM角色。如需將帳戶連線和預設IAM角色新增至環境的資訊，請參閱建立環境。
預設IAM角色必須包含動作所需的原則和權限。若要判斷這些原則和權限是什麼，請參閱動作的YAML定義文件中角色屬性的說明。

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

對應的使用者介面：下列其中一項視動作版本而定：

（較新版本）配置選項卡/環境/ my-environment? /三點菜單/切換角色
（舊版本）配置選項卡/「環境/帳戶/角色」/帳AWS 戶連接

Name

(DeployCloudFormationStack/Environment/Connections/Name)

（如果包含Connections，則為必填）

指定帳戶連線的名稱。

對應的使用者介面：下列其中一項視動作版本而定：

（較新版本）配置選項卡/環境/ my-environment? /三點菜單/切換角色
（舊版本）配置選項卡/「環境/帳戶/角色」/帳AWS 戶連接

Role

(DeployCloudFormationStack/Environment/Connections/Role)

（如果包含Connections，則為必填）

指定「部署 AWS CloudFormation 堆疊」動作用來存取的IAM角色名稱 AWS 和 AWS CloudFormation 服務。請確定您已將角色新增至您的 CodeCatalyst 空間，且該角色包含下列原則。

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

下列權限原則：

警告

將權限限制為以下策略中顯示的權限。使用具有更廣泛權限的角色可能會造成安全風險。


{
    "Version": "2012-10-17",
    "Statement": [{
    "Action": [
        "cloudformation:CreateStack",
        "cloudformation:DeleteStack",
        "cloudformation:Describe*",
        "cloudformation:UpdateStack",
        "cloudformation:CreateChangeSet",
        "cloudformation:DeleteChangeSet",
        "cloudformation:ExecuteChangeSet",
        "cloudformation:SetStackPolicy",
        "cloudformation:ValidateTemplate",
        "cloudformation:List*",
        "iam:PassRole"
    ],
    "Resource": "*",
    "Effect": "Allow"
}]
}

注意

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


"Resource": "*"

下列自訂信任原則：


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

注意

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

對應的使用者介面：下列其中一項視動作版本而定：

（較新版本）配置選項卡/環境/ my-environment? /三點菜單/切換角色
(舊版) 組態索引標籤/「環境/帳戶/角色」/「角色」

Inputs

(DeployCloudFormationStack/Inputs)

(選用)

本Inputs節定義了工作流程執行期間所DeployCloudFormationStack需的資料。

注意

每個「部署 AWS CloudFormation 堆疊」動作最多允許四個輸入 (一個來源和三個成品)。

如果您需要引用駐留在不同輸入中的文件（例如源和工件），則源輸入是主輸入，並且工件是輔助輸入。輔助輸入中的文件的引用採用特殊前綴，以將它們從主輸入中刪除。如需詳細資訊，請參閱範例：參考多個成品中的檔案。

對應的 UI：輸入索引標籤

Sources

(DeployCloudFormationStack/Inputs/Sources)

(如果您的 CloudFormation 或 AWS SAM 範本儲存在來源儲存庫中，則需要)

如果您的 CloudFormation 或 AWS SAM 範本儲存在來源儲存庫中，請指定該來源儲存庫的標籤。目前，唯一支援的標籤是WorkflowSource。

如果您的 CloudFormation 或 AWS SAM 範本未包含在來源儲存庫中，則該範本必須位於由其他動作產生的成品或 Amazon S3 儲存貯體中。

如需來源的詳細資訊，請參閱將來源儲存庫連線至工作流程。

對應的用戶界面：輸入選項卡/源- 可選

Artifacts - input

(DeployCloudFormationStack/Inputs/Artifacts)

(如果您的 CloudFormation 或 AWS SAM 範本儲存在先前動作的輸出成品中，則需要)

如果您要部署的 CloudFormation 或 AWS SAM 範本包含在先前動作所產生的成品中，請在此指定該成品。如果您的 CloudFormation 範本未包含在成品中，則該範本必須位於來源儲存庫或 Amazon S3 儲存貯體中。

如需人工因素的詳細資訊 (包括範例)，請參閱在動作之間共用成品和檔案。

對應的 UI：配置選項卡/成品- 可選

Configuration

(DeployCloudFormationStack/Configuration)

(必要)

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

對應的 UI：組態索引標籤

name

(DeployCloudFormationStack/Configuration/name)

(必要)

指定部署 CloudFormation 堆疊動作建立或更新的 AWS CloudFormation 堆疊名稱。

對應的 UI：配置選項卡/堆棧名稱

region

(DeployCloudFormationStack/Configuration/region)

(必要)

指定 AWS 區域要部署堆疊的目標。如需區域代碼的清單，請參閱區域端點。

對應的 UI：配置選項卡/堆棧區域

template

(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

注意

您可能需要在範本的檔案路徑中新增前置詞，以指出要在其中尋找的成品或來源。如需詳細資訊，請參閱參考來源儲存庫檔案及參考人工因素中的檔案。

對應的 UI：配置選項卡/模板

role-arn

(DeployCloudFormationStack/Configuration/role-arn)

(必要)

指定堆疊角色的 Amazon 資源名稱 (ARN)。 CloudFormation 使用此角色存取和修改堆疊中的資源。例如：arn:aws:iam::123456789012:role/StackRole。

請確定堆疊角色包括：

一或多個權限原則。原則取決於您堆疊中擁有的資源。例如，如果您的堆疊包含 AWS Lambda 函數，則需要新增授與 Lambda 存取權的許可。如果您遵循中所述的教學課程教學課程：部署無伺服器應用程式，它會包含一個標題為的程序若要建立堆疊角色，列出當您部署典型的無伺服器應用程式堆疊時，堆疊角色所需的權限。

警告
將權限限制為 CloudFormation 服務存取堆疊中資源所需的權限。使用具有更廣泛權限的角色可能會造成安全風險。

下列信任原則：


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

選擇性地將此角色與您的帳戶連線產生關聯。若要進一步瞭解如何將IAM角色與帳戶連線產生關聯，請參閱將IAM角色新增至帳戶連線。如果您未將堆疊角色與帳戶連線產生關聯，則堆疊角色將不會出現在可視化編輯器的 [堆疊角色] 下拉式清單中；不過，仍ARN可使用YAML編輯器在role-arn欄位中指定角色。

注意

對應的 UI：配置選項卡/堆棧角色- 可選

capabilities

(DeployCloudFormationStack/Configuration/capabilities)

(必要)

指定允許 AWS CloudFormation 建立特定堆疊所需的IAM功能清單。在大多數情況下，您可capabilities以保留預設值CAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND。

如果您##[error] requires capabilities: [capability-name]在部署 AWS CloudFormation 堆疊動作的記錄檔中看到，請參閱以如何修正IAM功能錯誤？取得有關如何修正問題的詳細資訊。

如需有關IAM權能的詳細資訊，請參閱《使用指南》中的〈認可 AWS CloudFormation 範本中的IAMIAM資源〉。

對應的使用者介面：組態索引標籤/進階/功能

parameter-overrides

(DeployCloudFormationStack/Configuration/parameter-overrides)

(選用)

在您的 AWS CloudFormation 或 AWS SAM 範本中指定沒有預設值的參數，或您要為其指定非預設值的參數。若要取得有關參數的更多資訊，請參閱《 AWS CloudFormation 使用指南》中的參數

該parameter-overrides物業接受：

包含參數和值的JSON檔案。
以逗號分隔的參數和值清單。

指定JSON檔案的步驟

請確定JSON檔案使用下列其中一種語法：
```
{
  "Parameters": {
    "Param1": "Value1",
    "Param2": "Value2",
    ...
  }
}
```
或者...
```
[
  {
     "ParameterKey": "Param1",
     "ParameterValue": "Value1"
  },
  ...
]
```
（還有其他語法，但 CodeCatalyst 在撰寫本文時不支持它們。）如需有關在JSON檔案中指定 CloudFormation 參數的詳細資訊，請參閱《AWS CLI 命令參考》中的支援JSON語法。

使用下列其中一種格式指定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

例如，假設下列 AWS CloudFormation 範本：


##My CloudFormation template

Description: My AWS 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 會使用指定參數名稱的現有參數值。

對應的介面：

設定標籤/進階/參數覆寫
組態標籤/進階/參數覆寫/使用檔案指定取代
組態標籤/進階/參數覆寫/使用值組指定取代

no-execute-changeset

(DeployCloudFormationStack/Configuration/no-execute-changeset)

(選用)

指定是否 CodeCatalyst 要建立變更集，然後在執行 CloudFormation 變更集之前停止變更集。這可讓您檢閱 CloudFormation 主控台中設定的變更。如果您確定變更集看起來不錯，請停用此選項，然後重新執行工作流程， CodeCatalyst 以便建立並執行變更集而不會停止。預設為建立並執行變更集而不停止。如需詳細資訊，請參閱《AWS CLI 命令參考》中的 AWS CloudFormation 部署參數。若要取得有關檢視變更集的更多資訊，請參閱《AWS CloudFormation 使用指南》中的〈檢視變更集〉。

對應的使用者介面：組態標籤/進階/無執行變更集

fail-on-empty-changeset

(DeployCloudFormationStack/Configuration/fail-on-empty-changeset)

(選用)

指定如果 CloudFormation 變更集 CodeCatalyst 為空，是否要讓「部署 AWS CloudFormation 堆疊」動作失敗。(如果變更集是空的，則表示在最新部署期間沒有對堆疊進行任何變更。) 預設值是在變更集為空時允許動作繼續執行，並傳回UPDATE_COMPLETE訊息，即使堆疊尚未更新。

如需有關此設定的詳細資訊，請參閱《AWS CLI 命令參考》中的 AWS CloudFormation 部署參數。如需有關變更集的詳細資訊，請參閱使用指南中的使用變更集更新堆疊。AWS CloudFormation

對應的 UI：配置選項卡/高級/空變更集上失敗

disable-rollback

(DeployCloudFormationStack/Configuration/disable-rollback)

(選用)

指定 CodeCatalyst 堆疊部署失敗時是否要復原。回滾將堆棧返回到最後一個已知的穩定狀態。預設值為啟用復原。如需有關此設定的詳細資訊，請參閱《AWS CLI 命令參考》中的 AWS CloudFormation 部署參數。

如需部署 AWS CloudFormation 堆疊動作如何處理復原的詳細資訊，請參閱設定回復。

若要取得有關復原堆疊的詳細資訊，請參閱《AWS CloudFormation 使用指南》中的〈堆疊失敗選項〉。

對應的使用者介面：設定索引標籤/進階/停用復原

termination-protection

(DeployCloudFormationStack/Configuration/termination-protection)

(選用)

指定是否要 Deploy AWS CloudFormation 堆疊將終止保護新增至其部署的堆疊。如果使用者嘗試刪除啟用終止保護的堆疊，則刪除會失敗，且堆疊及其狀態保持不變。預設為停用終止保護。若要取得更多資訊，請參閱《AWS CloudFormation 使用指南》中的〈保護堆疊不被刪除〉。

對應的使用者介面：組態索引標籤/進階/終止保護

timeout-in-minutes

(DeployCloudFormationStack/Configuration/timeout-in-minutes)

(選用)

指定逾時堆疊建立作業並將堆疊狀態設定為之前 CloudFormation 應分配的時間量 (以分鐘為CREATE_FAILED單位)。如果 CloudFormation無法在分配的時間內創建整個堆棧，則由於超時而導致堆棧創建失敗並回滾堆棧。

依預設，堆疊建立沒有逾時。不過，個別資源可能會因其實作的服務性質而有自己的逾時。例如，如果堆疊中的個別資源逾時，堆疊建立也會逾時，即使尚未達到您指定的堆疊建立逾時。

對應的使用者介面：組態索引標籤/進階/逾CloudFormation時

notification-arns

(DeployCloudFormationStack/Configuration/notification-arns)

(選用)

指定您要 CodeCatalyst 向ARN其傳送通知訊息的 Amazon SNS 主題。例如 arn:aws:sns:us-east-1:111222333:MyTopic。執行「部署 AWS CloudFormation 堆疊」動作時，請 CodeCatalyst 協調 CloudFormation 以在堆疊建立或更新程序期間發生的每個 AWS CloudFormation 事件傳送一個通知。事件會顯示在堆疊的 AWS CloudFormation 主控台的 [事件] 索引標籤中。) 您最多可以指定五個主題。如需詳細資訊，請參閱什麼是 AmazonSNS？。

對應的使用者介面：設定索引標籤/進階/通知 ARNs

monitor-alarm-arns

(DeployCloudFormationStack/Configuration/monitor-alarm-arns)

(選用)

指定 Amazon CloudWatch 警示用作回滾觸發器的 Amazon 資源名稱 (ARN)。例如 arn:aws:cloudwatch::123456789012:alarm/MyAlarm。您最多可以有五個回復觸發器。

注意

如果您指定 CloudWatch 警示ARN，您還需要設定其他權限，以啟用動作才能存取 CloudWatch。如需詳細資訊，請參閱設定回復。

對應的使用者介面：組態標籤/進階/監控警示 ARNs

monitor-timeout-in-minutes

(DeployCloudFormationStack/Configuration/monitor-timeout-in-minutes)

(選用)

指定從 0 到 180 分鐘的時間長度，在此期間 CloudFormation 監視指定的警報。在部署所有堆疊資源之後開始監視。如果警示在指定的監視時間內發生，則部署會失敗，並 CloudFormation 復原整個堆疊作業。

預設值：0。 CloudFormation 只會在部署堆疊資源時監控警示，而不會在之後監視警示。

對應的使用者介面：組態標籤/進階/監控時間