參考：ContainerProperties 的任務定義參數

您必須在註冊任務定義時指定名稱。名稱長度最多可達 128 個字元。可以包含大小寫字母、數字、連字號 (-) 和底線 (_)。以該名稱註冊的第一個任務定義會獲得 1 的修訂。後續使用該名稱註冊的任何任務定義，將取得遞增的修訂版號碼。

類型：字串

必要：是

註冊任務定義時，需指定任務類型。如果任務在 Fargate 資源上執行，multinode則不支援 。如需多節點平行任務的詳細資訊，請參閱「建立多節點平行任務定義」。

類型：字串

有效值：container | multinode

必要：是

當您提交任務時，您可以指定取代預留位置的參數，或覆寫預設任務定義參數。任務提交要求中的參數，優先於任務定義中的預設值。這表示您可以針對使用相同格式的多個任務使用相同的任務定義。您也可以在提交時以程式設計方式變更命令中的值。

類型：字串到字串映射

必要：否

註冊任務定義時，您可以在任務容器屬性的 command 欄位使用參數替換預留位置。語法如下。

"command": [
    "ffmpeg",
    "-i",
    "Ref::inputfile",
    "-c",
    "Ref::codec",
    "-o",
    "Ref::outputfile"
]

在上述範例中，命令中有 Ref::inputfile、Ref::codec 和 Ref::outputfile 參數替換預留位置。您可以在任務定義中使用 parameters 物件來設定這些預留位置的預設值。例如，若要設定 Ref::codec 預留位置的預設值，您應在任務定義中指定下列各項：

"parameters" : {"codec" : "mp4"}

提交此任務定義以執行時，容器命令中的Ref::codec引數會取代為預設值 mp4。

傳遞至容器的命令。此參數會映射至 Docker Remote API 的建立容器區段中的 Cmd 以及 docker run 的 COMMAND 參數。如需 Docker CMD 參數的詳細資訊，請參閱 https://docs.docker.com/engine/reference/builder/#cmd。

"command": ["string", ...]

類型：字串陣列

必要：否

傳遞至容器的環境變數。此參數會映射到 Docker Remote API 的建立容器區段中的 Env 以及 docker run 的 --env 選項。

類型：金鑰值對的陣列

必要：否

"environment" : [
    { "name" : "envName1", "value" : "envValue1" },
    { "name" : "envName2", "value" : "envValue2" }
]

註冊任務定義時，您可以指定 IAM 角色。此角色提供 Amazon ECS 容器代理程式代表您呼叫其相關聯政策中指定之 API 動作的許可。在 Fargate 資源上執行的任務必須提供執行角色。如需詳細資訊，請參閱AWS Batch IAM 執行角色。

類型：字串

必要：否

在 Fargate 資源上執行之任務的平台組態。在 EC2 資源上執行的任務不得指定此參數。

類型：FargatePlatformConfiguration 物件

必要：否

用來啟動任務的映像。此字串會直接傳遞至 Docker 常駐程式。根據預設，Docker Hub 登錄檔中的映像為可用。您也可以用 repository-url/image:tag 指定其他儲存庫。允許最多 255 個字元 (大小寫)、數字、連字號、底線、等號、句號、正斜線、井號。此參數會映射至 Docker Remote API 的建立容器區段中的 Image 以及 docker run 的 IMAGE 參數。

類型：字串

必要：是

用於多節點平行任務的執行個體類型。所有節點平行任務中的所有節點群組皆必須使用相同的執行個體類型。此參數不適用於單一節點容器任務或在 Fargate 資源上執行的任務。

類型：字串

必要：否

註冊任務定義時，您可以指定 IAM 角色。角色提供任務容器權限，允許其代表您呼叫相關聯政策中指定的 API 動作。如需詳細資訊，請參閱《Amazon Elastic Container Service 開發人員指南》中的任務 IAM 角色。

類型：字串

必要：否

Linux 特定的修改，會套用到容器，例如用於裝置映射的詳細資訊。

"linuxParameters": {
    "devices": [
        {
            "hostPath": "string",
            "containerPath": "string",
            "permissions": [
                "READ", "WRITE", "MKNOD"
            ]
        }
    ],
    "initProcessEnabled": true|false,
    "sharedMemorySize": 0,
    "tmpfs": [
        {
            "containerPath": "string",
            "size": integer,
            "mountOptions": [
                "string"
            ]
        }
    ],
    "maxSwap": integer,
    "swappiness": integer
}

類型：LinuxParameters 物件

必要：否

任務的日誌組態規格。

此參數對應到 Docker Remote API Create a container (建立容器) 一節中的 LogConfig，以及 Docker run 的 --log-driver 選項。根據預設，容器會和 Docker 常駐程式使用一樣的日誌記錄驅動程式。不過，容器可以使用與 Docker 協助程式不同的記錄驅動程式，方法是在容器定義中指定具有此參數的日誌驅動程式。若要為容器使用不同的記錄驅動程式，必須在容器執行個體或其他日誌伺服器上設定日誌系統，以提供遠端記錄選項。如需支援的不同日誌驅動程式選項的詳細資訊，請參閱 Docker 文件中的 Configure logging drivers (設定日誌驅動程式)。

在您的容器執行個體上，此參數需要 1.18 版或更新版本的 Docker Remote API。若要檢查容器執行個體的 Docker Remote API 版本，請登入容器執行個體，並執行下列命令：sudo docker version | grep "Server API version"

"logConfiguration": {
    "devices": [
        {
            "logDriver": "string",
            "options": {
                "optionName1" : "optionValue1",
                "optionName2" : "optionValue2"
            }
            "secretOptions": [
              {
                  "name" : "secretOptionName1",
                  "valueFrom" : "secretOptionArn1"
              },
              {
                  "name" : "secretOptionName2",
                  "valueFrom" : "secretOptionArn2"
              }
            ]
        }
    ]
}

類型：LogConfiguration 物件

必要：否

此參數已棄用，請resourceRequirements改用 。

為任務預留的記憶體 MiB 數量。

如果您的任務定義包含類似下列的語法resourceRequirements，則做為如何使用 的範例。

"containerProperties": {
  "memory": 512
}

使用 的同等語法resourceRequirements如下所示。

"containerProperties": {
  "resourceRequirements": [
    {
      "type": "MEMORY",
      "value": "512"
    }
  ]
}

類型：整數

必要：是

容器中資料磁碟區的掛載點。此參數會映射到 Docker Remote API 的建立容器區段中的 Volumes 以及 docker run 的 --volume 選項。

"mountPoints": [
                {
                  "sourceVolume": "string",
                  "containerPath": "string",
                  "readOnly": true|false
                }
              ]

類型：物件陣列

必要：否

在 Fargate 資源上執行之任務的網路組態。在 EC2 資源上執行的任務不得指定此參數。

"networkConfiguration": { 
   "assignPublicIp": "string"
}

類型：物件陣列

必要：否

此參數為 true 時，容器便會取得主機容器執行個體的更高許可 (類似 root 使用者)。此參數會映射到 Docker Remote API 的建立容器區段中的 Privileged 以及 docker run 的 --privileged 選項。此參數不適用於在 Fargate 資源上執行的任務。請勿提供或指定為 false。

"privileged": true|false

類型：布林值

必要：否

此參數為 true 時，容器會取得根檔案系統的唯讀存取權。此參數會映射到 Docker Remote API 的建立容器區段中的 ReadonlyRootfs 以及 docker run 的 --read-only 選項。

"readonlyRootFilesystem": true|false

類型：布林值

必要：否

指派給容器的資源類型和數量。支援的資源包括 GPU MEMORY 和 VCPU。

"resourceRequirements" : [
  {
    "type": "GPU",
    "value": "number"
  }
]

類型：物件陣列

必要：否

公開為環境變數的任務秘密。如需詳細資訊，請參閱指定敏感資料。

"secrets": [
    {
      "name": "secretName1",
      "valueFrom": "secretArn1"
    },
    {
      "name": "secretName2",
      "valueFrom": "secretArn2"
    }
    ...
]

類型：物件陣列

必要：否

容器中要設定的 ulimits 值的清單。此參數會映射到 Docker Remote API 的建立容器區段中的 Ulimits 以及 docker run 的 --ulimit 選項。

"ulimits": [
  {
    "name": string,
    "softLimit": integer,
    "hardLimit": integer
  }
  ...
]

類型：物件陣列

必要：否

要在容器內使用的使用者名稱。此參數會映射到 Docker Remote API 的建立容器區段中的 User 以及 docker run 的 --user 選項。

"user": "string"

類型：字串

必要：否

此參數已棄用，請resourceRequirements改用 。

為容器保留的 vCPU 數量。

如果您的任務定義包含類似以下的行resourceRequirements，則做為如何使用 的範例：

"containerProperties": {
  "vcpus": 2
}

使用 resourceRequirements的同等行如下所示。

"containerProperties": {
  "resourceRequirements": [
    {
      "type": "VCPU",
      "value": "2"
    }
  ]
}

類型：整數

必要：是

註冊任務定義時，您可指定磁碟區清單，那些磁碟區會傳送到容器執行個體上的 Docker 協助程式。容器屬性允許使用以下參數：

"volumes": [
  {
    "name": "string",
    "host": {
      "sourcePath": "string"
    },
    "efsVolumeConfiguration": {
      "authorizationConfig": {
        "accessPointId": "string",
        "iam": "string"
      },
      "fileSystemId": "string",
      "rootDirectory": "string",
      "transitEncryption": "string",
      "transitEncryptionPort": number
    }
  }
]

任務 Kubernetes Pod 資源的屬性。

類型：EksPodProperties 物件

必要：否

任務定義所需的平台功能。如果未指定任何值，則預設為 EC2。對於在 Fargate 資源上執行的任務， FARGATE 會指定 。

類型：字串

有效值：EC2 | FARGATE

必要：否

指定是否要將標籤從任務或任務定義傳播到對應的 Amazon ECS 任務。如果沒有指定值，則不會傳播標籤。標籤只能在建立任務時傳播到任務。對於具有相同名稱的標籤，任務標籤優先於任務定義標籤。如果任務和任務定義的合併標籤總數超過 50，任務會移至 FAILED 狀態。

類型：布林值

必要：否

註冊多節點平行任務定義時，您必須指定節點屬性的清單。這些節點屬性會定義任務中使用的節點數量、主節點索引，以及要使用的不同節點範圍。如果任務在 Fargate 資源上執行，則您無法指定 nodeProperties。請改用 containerProperties。任務定義允許使用以下的節點屬性。如需詳細資訊，請參閱多節點平行任務。

類型：NodeProperties 物件

必要：否

註冊任務定義，您可以選擇性指定任務失敗後要使用的重試策略，隨此任務定義提交。在 SubmitJob 操作期間指定的任何重試策略都會覆寫此處定義的重試策略。根據預設，每個任務將嘗試一次。如果您指定多個嘗試，則任務會在失敗時重試。失敗嘗試的範例包括任務傳回非零結束碼，或容器執行個體終止。如需詳細資訊，請參閱自動化任務重試。

類型：RetryStrategy 物件

必要：否

與此任務定義一起提交的任務的排程優先順序。這只會影響具有公平共享政策的任務佇列中的任務。排程優先順序較高的任務會排在排程優先順序較低的任務之前。

支援的最小值為 0，支援的最大值為 9999。

類型：整數

必要：否

要與任務定義建立關聯的鍵值對標籤。如需詳細資訊，請參閱標記您的 AWS Batch 資源。

類型：字串到字串映射

必要：否

您可以設定任務的逾時持續時間，以便在任務執行時間超過此時間時 AWS Batch 終止任務。如需詳細資訊，請參閱任務逾時。如果任務因逾時而終止，則不會重試。在 SubmitJob 操作期間指定的任何逾時組態都會覆寫此處定義的逾時組態。如需詳細資訊，請參閱任務逾時。

類型：JobTimeout 物件

必要：否