AWS-ECSRunTask - AWS Systems Manager 自動化手冊參考

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

AWS-ECSRunTask

Description

AWS-ECSRunTask執行手冊執行您指定的 Amazon 彈性容器服務 (AmazonECS) 任務。

運行此自動化（控制台）

文件類型

 自動化

擁有者

Amazon

平台

Linux

參數

  • AutomationAssumeRole

    類型：字串

    描述：(選用) 允許 Systems Manager 自動化代表您執行動作的 AWS Identity and Access Management (IAM) 角色的 Amazon 資源名稱 ()。ARN如果未指定角色，Systems Manager 自動化會使用啟動此 runbook 的使用者的權限。

  • capacityProviderStrategy

    類型：字串

    描述：(選擇性) 用於工作的容量提供者策略。

  • 叢集

    類型：字串

    說明：(選擇性) 要在其上執行工作ARN的叢集的簡短名稱。如果未指定叢集，則會使用預設叢集。

  • count

    類型：字串

    描述：(選擇性) 要放置在叢集上之指定工作的建立數目。您最多可以為每個請求指定 10 個任務。

  • enableECSManaged标签

    類型：布林值

    說明：(選用) 指定是否對任務使用 Amazon ECS 受管標籤。如需詳細資訊，請參閱 Amazon 彈性容器服務開發人員指南中的標記 Amazon ECS 資源。

  • enableExecuteCommand

    類型：布林值

    描述：(選擇性) 決定是否啟動此工作中容器的執行命令功能。如果為 true，則會在工作中的所有容器上啟動執行命令功能。

  • 群組

    類型：字串

    描述：(選擇性) 要與任務相關聯的任務群組名稱。預設值是工作定義的系列名稱。例如：family:my-family-name。

  • launchType

    類型：字串

    有效值：EC2| FARGATE | EXTERNAL

    描述：(選擇性) 執行獨立工作的基礎結構。

  • networkConfiguration

    類型：字串

    描述：(選擇性) 工作的網路組態。若工作定義使用awsvpc網路模式接收自己的 elastic network interface，則需要此參數，而其他網路模式則不支援此參數。

  • 覆蓋

    類型：字串

    描述：(選擇性) 容器覆寫的JSON格式清單，用來指定指定工作定義中容器的名稱，以及該容器應接收的覆寫。您可以覆寫在工作定義或 Docker 映像檔中指定的容器的預設命令，並使用命令覆寫。您也可以覆寫在工作定義或容器上 Docker 映像檔中指定的現有環境變數。此外，您可以使用環境覆寫來新增環境變數。

  • placementConstraints

    類型：字串

    描述：(選擇性) 要用於工作的位置限制物件陣列。您最多可以為每個任務指定 10 個條件約束，包括任務定義中的條件約束和在執行時間指定的條件約束。

  • placementStrategy

    類型：字串

    描述：(選擇性) 用於任務的放置策略物件。您最多可以為每個任務指定 5 個策略規則。

  • platformVersion

    類型：字串

    說明：(選擇性) 工作使用的平台版本。平台版本僅針對在 Fargate 上託管的任務指定。如果未指定平台版本，將使用 LATEST 平台版本。

  • propagateTags

    類型：字串

    描述：(選擇性) 決定標籤是否從作業定義傳播至作業。如果沒有指定值，則不會傳播標籤。標籤只能在任務建立期間傳播至任務。

  • referenceId

    類型：字串

    描述：(選擇性) 用於工作的參照 ID。參照識別碼的長度上限為 1024 個字元。

  • startedBy

    類型：字串

    說明：(選擇性) 在工作啟動時指定的選用標籤。這可協助您識別哪些工作屬於特定工作，方法是篩選ListTasksAPI作業的結果。允許最多 36 個字母（大寫和小寫），數字，連字符（-）和底線（_）。

  • 標籤

    類型：字串

    描述：(選用) 您要套用至工作的中繼資料，以協助您分類和組織工作。每個標籤都包含使用者定義的索引鍵和值。

  • taskDefinition

    類型：字串

    描述：(選擇性) 要執行ARN的工作定義family與 revision (family:revision) 或完整。如果未指定修訂，則會使用最新的ACTIVE修訂版本。

必要的IAM權限

此AutomationAssumeRole參數需要執行下列動作，才能成功使用 Runbook。

  • ecs:RunTask

文件步驟

aws:executeScript-根據您為執行簿輸入參數指定的值執行 Amazon ECS 任務。