AWS-ECSRunTask - AWS Systems Manager 自動化 Runbook 參考

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

AWS-ECSRunTask

Description

AWS-ECSRunTask Runbook 會執行您指定的 Amazon Elastic Container Service (Amazon ECS) 任務。

執行此自動化 (主控台)

文件類型

 自動化

擁有者

Amazon

平台

Linux

參數

  • AutomationAssumeRole

    類型:字串

    描述:(選用) 允許 Systems Manager Automation 代表您執行動作的 (IAM) 角色的 AWS Identity and Access Management Amazon Resource Name (ARN)。如果未指定角色,Systems Manager Automation 會使用啟動此 Runbook 的使用者許可。

  • capacityProviderStrategy

    類型:字串

    描述:(選用) 用於任務的容量提供者策略。

  • 叢集

    類型:字串

    描述:(選用) 執行任務的叢集的簡短名稱或 ARN。如果您未指定叢集,則會使用預設叢集。

  • count

    類型:字串

    描述:(選用) 要放置在叢集上之指定任務的執行個體數量。您可以為每個請求指定最多 10 個任務。

  • enableECSManagedTags

    類型:布林值

    描述:(選用) 指定是否對任務使用 Amazon ECS 受管標籤。如需詳細資訊,請參閱《Amazon Elastic Container Service 開發人員指南》中的標記您的 Amazon ECS 資源

  • enableExecuteCommand

    類型:布林值

    描述:(選用) 決定是否為此任務中的容器啟用執行命令功能。如果為 true,這會啟用任務中所有容器的執行命令功能。

  • 群組

    類型:字串

    描述:(選用) 要與任務建立關聯的任務群組名稱。預設值是任務定義的系列名稱。例如 family:my-family-name

  • launchType

    類型:字串

    有效值:EC2 | FARGATE | EXTERNAL

    描述:(選用) 執行獨立任務的基礎設施。

  • networkConfiguration

    類型:字串

    描述:(選用) 任務的網路組態。使用 awsvpc 網路模式接收自己的彈性網路介面的任務定義需要此參數,其他網路模式不支援此參數。

  • 覆寫

    類型:字串

    描述:(選用) JSON 格式的容器覆寫清單,指定指定任務定義中的容器名稱,以及應接收的覆寫。您可以使用命令覆寫來覆寫任務定義或 Docker 映像中指定的容器的預設命令。您也可以覆寫任務定義或容器上的 Docker 映像中指定的現有環境變數。此外,您可以使用環境覆寫來新增環境變數。

  • placementConstraints

    類型:字串

    描述:(選用) 用於任務的置放限制物件陣列。您可以為每個任務指定最多 10 個限制,包括任務定義中的限制,以及在執行時間指定的限制。

  • placementStrategy

    類型:字串

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

  • platformVersion

    類型:字串

    描述:(選用) 任務使用的平台版本。平台版本僅針對 Fargate 上託管的任務指定。如果未指定平台版本,將使用 LATEST 平台版本。

  • propagateTags

    類型:字串

    描述:(選用) 決定標籤是否從任務定義傳播到任務。如果沒有指定值,則不會傳播標籤。標籤只能在任務建立期間傳播至任務。

  • referenceId

    類型:字串

    描述:(選用) 用於任務的參考 ID。參考 ID 的長度上限為 1024 個字元。

  • startedBy

    類型:字串

    描述:(選用) 任務啟動時指定的選用標籤。這可協助您篩選 ListTasks API 操作的結果,以識別哪些任務屬於特定任務。最多允許 36 個字母 (大寫和小寫)、數字、連字號 (-) 和底線 (_)。

  • 標籤

    類型:字串

    描述:(選用) 您要套用至任務的中繼資料,以協助您分類和組織任務。每個標籤都由使用者定義的索引鍵和值組成。

  • taskDefinition

    類型:字串

    描述:(選用) 要執行之任務定義的 familyrevision(familyrevision) 或完整 ARN。如果未指定修訂版,則會使用最新的ACTIVE修訂版。

必要的 IAM 許可

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

  • ecs:RunTask

文件步驟

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