的 Job 定义参数 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 资源上运行的作业，必须提供执行角色。有关更多信息，请参阅 Amazon 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 的创建容器部分中的LogConfig以及 Docker 运行的--log-driver选项。默认情况下，容器使用与 Docker 进程守护程序相同的日志记录驱动程序。但容器可能通过在容器定义中使用此参数指定日志驱动程序，以此来使用不同于 Docker 进程守护程序的日志记录驱动程序。要对容器使用另一个日志记录驱动程序，必须在容器实例或另一个日志服务器上配置日志系统，以提供远程日志记录选项。有关其他支持的日志驱动程序选项的更多信息，请参阅 Docker 文档中的配置日志记录驱动程序。

此参数要求容器实例上的 Docker Remote API 版本为 1.18 或更高版本。要检查容器实例上的 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。

类型：整数

必需：否

与作业定义关联的键值配对标签。有关更多信息，请参阅 对Amazon Batch资源加标签。

类型：字符串到字符串映射

必需：否

您可以为作业配置超时时间，这样，如果作业运行的时间超过该时间，则 Amazon Batch 终止该作业。有关更多信息，请参阅 作业超时。如果作业是因超时而终止，则不会重试。在SubmitJob操作期间指定的任何超时配置都会覆盖此处定义的超时配置。有关更多信息，请参阅 作业超时。

类型：JobTimeout 对象

必需：否