- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
account_idType: STRING
consumable_resource_propertiesType: STRUCT
Provider name: consumableResourceProperties
Description: Contains a list of consumable resources required by the job.
consumable_resource_listUNORDERED_LIST_STRUCTconsumableResourceListconsumable_resourceSTRINGconsumableResourcequantityINT64quantitycontainer_orchestration_typeType: STRING
Provider name: containerOrchestrationType
Description: The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
container_propertiesType: STRUCT
Provider name: containerProperties
Description: An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can’t be used in addition to eksProperties, ecsProperties, or nodeProperties.
commandUNORDERED_LIST_STRINGcommandCmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.environmentUNORDERED_LIST_STRUCTenvironmentEnv in the Create a container section of the Docker Remote API and the –env option to docker run. AWS_BATCH”. This naming convention is reserved for variables that Batch sets.nameSTRINGnamevalueSTRINGvalueephemeral_storageSTRUCTephemeralStoragesize_in_gibINT32sizeInGiB21 GiB and the maximum supported value is 200 GiB.execution_role_arnSTRINGexecutionRoleArnfargate_platform_configurationSTRUCTfargatePlatformConfigurationplatform_versionSTRINGplatformVersionLATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.imageSTRINGimagerepository-url/image:tag . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest .123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).ubuntu or mongo).amazon/amazon-ecs-agent).quay.io/assemblyline/ubuntu).instance_typeSTRINGinstanceTypejob_role_arnSTRINGjobRoleArnlinux_parametersSTRUCTlinuxParametersdevicesUNORDERED_LIST_STRUCTdevicesDevices in the Create a container section of the Docker Remote API and the –device option to docker run. container_pathSTRINGcontainerPathhostPath value is used.host_pathSTRINGhostPathpermissionsUNORDERED_LIST_STRINGpermissionsread, write, and mknod for the device.init_process_enabledBOOLEANinitProcessEnabledinit process inside the container that forwards signals and reaps processes. This parameter maps to the –init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep “Server API version”max_swapINT32maxSwap–memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see –memory-swap details in the Docker documentation. If a maxSwap value of 0 is specified, the container doesn’t use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn’t use the swap configuration for the container instance that it’s running on. A maxSwap value must be set for the swappiness parameter to be used. shared_memory_sizeINT32sharedMemorySize/dev/shm volume. This parameter maps to the –shm-size option to docker run. swappinessINT32swappinessswappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn’t specified, a default value of 60 is used. If a value isn’t specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn’t use swap. This parameter maps to the –memory-swappiness option to docker run. Consider the following when you use a per-container swap configuration.maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.tmpfsUNORDERED_LIST_STRUCTtmpfstmpfs mount. This parameter maps to the –tmpfs option to docker run. container_pathSTRINGcontainerPathtmpfs volume is mounted.mount_optionsUNORDERED_LIST_STRINGmountOptionstmpfs volume mount options. Valid values: “defaults” | “ro” | “rw” | “suid” | “nosuid” | “dev” | “nodev” | “exec” | “noexec” | “sync” | “async” | “dirsync” | “remount” | “mand” | “nomand” | “atime” | “noatime” | “diratime” | “nodiratime” | “bind” | “rbind” | “unbindable” | “runbindable” | “private” | “rprivate” | “shared” | “rshared” | “slave” | “rslave” | “relatime” | “norelatime” | “strictatime” | “nostrictatime” | “mode” | “uid” | “gid” | “nr_inodes” | “nr_blocks” | “mpol"sizeINT32sizetmpfs volume.log_configurationSTRUCTlogConfigurationLogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. sudo docker version | grep “Server API version” ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.log_driverSTRINGlogDriverawslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk. awslogs and splunk log drivers.sudo docker version | grep “Server API version”optionsMAP_STRING_STRINGoptionssudo docker version | grep “Server API version”secret_optionsUNORDERED_LIST_STRUCTsecretOptionsnameSTRINGnamevalue_fromSTRINGvalueFrommemoryINT32memoryresourceRequirements to specify the memory requirements for the job definition. It’s not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it’s terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.mount_pointsUNORDERED_LIST_STRUCTmountPointsVolumes in the Create a container section of the Docker Remote API and the –volume option to docker run.container_pathSTRINGcontainerPathread_onlyBOOLEANreadOnlytrue, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.source_volumeSTRINGsourceVolumenetwork_configurationSTRUCTnetworkConfigurationassign_public_ipSTRINGassignPublicIpDISABLED”.privilegedBOOLEANprivilegedroot user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run. The default value is false. readonly_root_filesystemBOOLEANreadonlyRootFilesystemReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run.repository_credentialsSTRUCTrepositoryCredentialscredentials_parameterSTRINGcredentialsParameterresource_requirementsUNORDERED_LIST_STRUCTresourceRequirementsGPU, MEMORY, and VCPU.typeSTRINGtypeGPU, MEMORY, and VCPU.valueSTRINGvaluetype specified.Memory in the Create a container section of the Docker Remote API and the –memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run. value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.VCPU = 0.25VCPU = 0.25 or 0.5VCPU = 0.25, 0.5, or 1VCPU = 0.5, or 1VCPU = 0.5, 1, or 2VCPU = 1 or 2VCPU = 1, 2, or 4VCPU = 2 or 4VCPU = 2, 4, or 8VCPU = 4VCPU = 4 or 8VCPU = 8VCPU = 8 or 16VCPU = 16CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once. The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference. For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16MEMORY = 512, 1024, or 2048MEMORY = 1024, 2048, 3072, or 4096MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880runtime_platformSTRUCTruntimePlatformcpu_architectureSTRINGcpuArchitectureX86_64. Valid values are X86_64 and ARM64. X86_64 for Windows containers. ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.operating_system_familySTRINGoperatingSystemFamilyLINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL. linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration. LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found. ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.secretsUNORDERED_LIST_STRUCTsecretsnameSTRINGnamevalue_fromSTRINGvalueFromulimitsUNORDERED_LIST_STRUCTulimitsulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. hard_limitINT32hardLimitulimit type.nameSTRINGnametype of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.soft_limitINT32softLimitulimit type.userSTRINGuserUser in the Create a container section of the Docker Remote API and the –user option to docker run.vcpusINT32vcpusresourceRequirements to specify the vCPU requirements for the job definition. It’s not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.volumesUNORDERED_LIST_STRUCTvolumesefs_volume_configurationSTRUCTefsVolumeConfigurationplatformVersion of at least 1.4.0.authorization_configSTRUCTauthorizationConfigaccess_point_idSTRINGaccessPointIdEFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.iamSTRINGiamEFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.file_system_idSTRINGfileSystemIdroot_directorySTRINGrootDirectory/ has the same effect as omitting this parameter. The maximum length is 4,096 characters. authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.transit_encryptionSTRINGtransitEncryptionDISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.transit_encryption_portINT32transitEncryptionPorthostSTRUCThosthost parameter determine whether your data volume persists on the host container instance and where it’s stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn’t guaranteed to persist after the containers that are associated with it stop running. source_pathSTRINGsourcePathnameSTRINGnamesourceVolume parameter of container definition mountPoints.ecs_propertiesType: STRUCT
Provider name: ecsProperties
Description: An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can’t be used in addition to containerProperties, eksProperties, or nodeProperties.
task_propertiesUNORDERED_LIST_STRUCTtaskPropertiescontainersUNORDERED_LIST_STRUCTcontainerscommandUNORDERED_LIST_STRINGcommandCmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see Dockerfile reference: CMD.depends_onUNORDERED_LIST_STRUCTdependsOnconditionSTRINGconditionSTART - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can’t be set on an essential container.SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can’t be set on an essential container.container_nameSTRINGcontainerNameenvironmentUNORDERED_LIST_STRUCTenvironment–env parameter to docker run. AWS_BATCH. This naming convention is reserved for variables that Batch sets.nameSTRINGnamevalueSTRINGvalueessentialBOOLEANessentialtrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn’t affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All jobs must have at least one essential container. If you have an application that’s composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.imageSTRINGimagerepository-url/image:tag or repository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of the docker run .linux_parametersSTRUCTlinuxParametersdevicesUNORDERED_LIST_STRUCTdevicesDevices in the Create a container section of the Docker Remote API and the –device option to docker run. container_pathSTRINGcontainerPathhostPath value is used.host_pathSTRINGhostPathpermissionsUNORDERED_LIST_STRINGpermissionsread, write, and mknod for the device.init_process_enabledBOOLEANinitProcessEnabledinit process inside the container that forwards signals and reaps processes. This parameter maps to the –init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep “Server API version”max_swapINT32maxSwap–memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see –memory-swap details in the Docker documentation. If a maxSwap value of 0 is specified, the container doesn’t use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn’t use the swap configuration for the container instance that it’s running on. A maxSwap value must be set for the swappiness parameter to be used. shared_memory_sizeINT32sharedMemorySize/dev/shm volume. This parameter maps to the –shm-size option to docker run. swappinessINT32swappinessswappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn’t specified, a default value of 60 is used. If a value isn’t specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn’t use swap. This parameter maps to the –memory-swappiness option to docker run. Consider the following when you use a per-container swap configuration.maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.tmpfsUNORDERED_LIST_STRUCTtmpfstmpfs mount. This parameter maps to the –tmpfs option to docker run. container_pathSTRINGcontainerPathtmpfs volume is mounted.mount_optionsUNORDERED_LIST_STRINGmountOptionstmpfs volume mount options. Valid values: “defaults” | “ro” | “rw” | “suid” | “nosuid” | “dev” | “nodev” | “exec” | “noexec” | “sync” | “async” | “dirsync” | “remount” | “mand” | “nomand” | “atime” | “noatime” | “diratime” | “nodiratime” | “bind” | “rbind” | “unbindable” | “runbindable” | “private” | “rprivate” | “shared” | “rshared” | “slave” | “rslave” | “relatime” | “norelatime” | “strictatime” | “nostrictatime” | “mode” | “uid” | “gid” | “nr_inodes” | “nr_blocks” | “mpol"sizeINT32sizetmpfs volume.log_configurationSTRUCTlogConfigurationLogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation. LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. –format ‘{{.Server.APIVersion}}’ ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.log_driverSTRINGlogDriverawslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk. awslogs and splunk log drivers.sudo docker version | grep “Server API version”optionsMAP_STRING_STRINGoptionssudo docker version | grep “Server API version”secret_optionsUNORDERED_LIST_STRUCTsecretOptionsnameSTRINGnamevalue_fromSTRINGvalueFrommount_pointsUNORDERED_LIST_STRUCTmountPointsVolumes in the Create a container section of the Docker Remote API and the –volume option to docker run. Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can’t mount directories on a different drive, and mount point can’t be across drives.container_pathSTRINGcontainerPathread_onlyBOOLEANreadOnlytrue, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.source_volumeSTRINGsourceVolumenameSTRINGnamedependsOn and Overrides objects.privilegedBOOLEANprivilegedtrue, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run. readonly_root_filesystemBOOLEANreadonlyRootFilesystemReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run. repository_credentialsSTRUCTrepositoryCredentialscredentials_parameterSTRINGcredentialsParameterresource_requirementsUNORDERED_LIST_STRUCTresourceRequirementstypeSTRINGtypeGPU, MEMORY, and VCPU.valueSTRINGvaluetype specified.Memory in the Create a container section of the Docker Remote API and the –memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run. value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.VCPU = 0.25VCPU = 0.25 or 0.5VCPU = 0.25, 0.5, or 1VCPU = 0.5, or 1VCPU = 0.5, 1, or 2VCPU = 1 or 2VCPU = 1, 2, or 4VCPU = 2 or 4VCPU = 2, 4, or 8VCPU = 4VCPU = 4 or 8VCPU = 8VCPU = 8 or 16VCPU = 16CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once. The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference. For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16MEMORY = 512, 1024, or 2048MEMORY = 1024, 2048, 3072, or 4096MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880secretsUNORDERED_LIST_STRUCTsecretsnameSTRINGnamevalue_fromSTRINGvalueFromulimitsUNORDERED_LIST_STRUCTulimitsulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format ‘{{.Server.APIVersion}}’ hard_limitINT32hardLimitulimit type.nameSTRINGnametype of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.soft_limitINT32softLimitulimit type.userSTRINGuserhost network mode, don’t run containers using the root user (UID 0). We recommend using a non-root user for better security. user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.useruser:groupuiduid:giduser:giuid:groupephemeral_storageSTRUCTephemeralStoragesize_in_gibINT32sizeInGiB21 GiB and the maximum supported value is 200 GiB.execution_role_arnSTRINGexecutionRoleArnipc_modeSTRINGipcModehost, task, or none. If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.network_configurationSTRUCTnetworkConfigurationassign_public_ipSTRINGassignPublicIpDISABLED”.pid_modeSTRINGpidModehost or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task. If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.platform_versionSTRINGplatformVersionLATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.runtime_platformSTRUCTruntimePlatformcpu_architectureSTRINGcpuArchitectureX86_64. Valid values are X86_64 and ARM64. X86_64 for Windows containers. ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.operating_system_familySTRINGoperatingSystemFamilyLINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL. linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration. LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found. ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.task_role_arnSTRINGtaskRoleArnvolumesUNORDERED_LIST_STRUCTvolumesefs_volume_configurationSTRUCTefsVolumeConfigurationplatformVersion of at least 1.4.0.authorization_configSTRUCTauthorizationConfigaccess_point_idSTRINGaccessPointIdEFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.iamSTRINGiamEFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.file_system_idSTRINGfileSystemIdroot_directorySTRINGrootDirectory/ has the same effect as omitting this parameter. The maximum length is 4,096 characters. authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.transit_encryptionSTRINGtransitEncryptionDISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.transit_encryption_portINT32transitEncryptionPorthostSTRUCThosthost parameter determine whether your data volume persists on the host container instance and where it’s stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn’t guaranteed to persist after the containers that are associated with it stop running. source_pathSTRINGsourcePathnameSTRINGnamesourceVolume parameter of container definition mountPoints.eks_propertiesType: STRUCT
Provider name: eksProperties
Description: An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can’t be used in addition to containerProperties, ecsProperties, or nodeProperties.
pod_propertiesSTRUCTpodPropertiescontainersUNORDERED_LIST_STRUCTcontainersargsUNORDERED_LIST_STRINGargsCMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container’s environment. If the referenced environment variable doesn’t exist, the reference in the command isn’t changed. For example, if the reference is to “$(NAME1)” and the NAME1 environment variable doesn’t exist, the command string will remain “$(NAME1).” $$ is replaced with $, and the resulting string isn’t expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.commandUNORDERED_LIST_STRINGcommandENTRYPOINT of the container image is used. Environment variable references are expanded using the container’s environment. If the referenced environment variable doesn’t exist, the reference in the command isn’t changed. For example, if the reference is to “$(NAME1)” and the NAME1 environment variable doesn’t exist, the command string will remain “$(NAME1).” $$ is replaced with $ and the resulting string isn’t expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can’t be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.envUNORDERED_LIST_STRUCTenvAWS_BATCH”. This naming convention is reserved for variables that Batch sets.nameSTRINGnamevalueSTRINGvalueimageSTRINGimageimage_pull_policySTRINGimagePullPolicyAlways, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.nameSTRINGnameDefault” is used. Each container in a pod must have a unique name.resourcesSTRUCTresourcesmemory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.limitsMAP_STRING_STRINGlimitsname that’s specified. Resources can be requested using either the limits or the requests objects.memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that’s specified in limits must be equal to the value that’s specified in requests. 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that’s specified in limits must be at least as large as the value that’s specified in requests.memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that’s specified in limits must be equal to the value that’s specified in requests.requestsMAP_STRING_STRINGrequestsname that’s specified. Resources can be requested by using either the limits or the requests objects.memory can be specified in limits, requests, or both. If memory is specified in both, then the value that’s specified in limits must be equal to the value that’s specified in requests. 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that’s specified in limits must be at least as large as the value that’s specified in requests.nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that’s specified in limits must be equal to the value that’s specified in requests.security_contextSTRUCTsecurityContextallow_privilege_escalationBOOLEANallowPrivilegeEscalationfalse.privilegedBOOLEANprivilegedtrue, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.read_only_root_filesystemBOOLEANreadOnlyRootFilesystemtrue, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.run_as_groupINT64runAsGroupgid). If this parameter isn’t specified, the default is the group that’s specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.run_as_non_rootBOOLEANrunAsNonRootuid other than 0. If this parameter isn’t specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.run_as_userINT64runAsUseruid). If this parameter isn’t specified, the default is the user that’s specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.volume_mountsUNORDERED_LIST_STRUCTvolumeMountsemptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.mount_pathSTRINGmountPathnameSTRINGnameread_onlyBOOLEANreadOnlytrue, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.sub_pathSTRINGsubPathdns_policySTRINGdnsPolicyClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod’s DNS policy in the Kubernetes documentation. Valid values: Default | ClusterFirst | ClusterFirstWithHostNethost_networkBOOLEANhostNetworktrue. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don’t require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.image_pull_secretsUNORDERED_LIST_STRUCTimagePullSecretsImagePullSecret$name is required when this object is used.nameSTRINGnameImagePullSecret. This object is required when EksPodProperties$imagePullSecrets is used.init_containersUNORDERED_LIST_STRUCTinitContainersargsUNORDERED_LIST_STRINGargsCMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container’s environment. If the referenced environment variable doesn’t exist, the reference in the command isn’t changed. For example, if the reference is to “$(NAME1)” and the NAME1 environment variable doesn’t exist, the command string will remain “$(NAME1).” $$ is replaced with $, and the resulting string isn’t expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.commandUNORDERED_LIST_STRINGcommandENTRYPOINT of the container image is used. Environment variable references are expanded using the container’s environment. If the referenced environment variable doesn’t exist, the reference in the command isn’t changed. For example, if the reference is to “$(NAME1)” and the NAME1 environment variable doesn’t exist, the command string will remain “$(NAME1).” $$ is replaced with $ and the resulting string isn’t expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can’t be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.envUNORDERED_LIST_STRUCTenvAWS_BATCH”. This naming convention is reserved for variables that Batch sets.nameSTRINGnamevalueSTRINGvalueimageSTRINGimageimage_pull_policySTRINGimagePullPolicyAlways, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.nameSTRINGnameDefault” is used. Each container in a pod must have a unique name.resourcesSTRUCTresourcesmemory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.limitsMAP_STRING_STRINGlimitsname that’s specified. Resources can be requested using either the limits or the requests objects.memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that’s specified in limits must be equal to the value that’s specified in requests. 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that’s specified in limits must be at least as large as the value that’s specified in requests.memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that’s specified in limits must be equal to the value that’s specified in requests.requestsMAP_STRING_STRINGrequestsname that’s specified. Resources can be requested by using either the limits or the requests objects.memory can be specified in limits, requests, or both. If memory is specified in both, then the value that’s specified in limits must be equal to the value that’s specified in requests. 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that’s specified in limits must be at least as large as the value that’s specified in requests.nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that’s specified in limits must be equal to the value that’s specified in requests.security_contextSTRUCTsecurityContextallow_privilege_escalationBOOLEANallowPrivilegeEscalationfalse.privilegedBOOLEANprivilegedtrue, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.read_only_root_filesystemBOOLEANreadOnlyRootFilesystemtrue, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.run_as_groupINT64runAsGroupgid). If this parameter isn’t specified, the default is the group that’s specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.run_as_non_rootBOOLEANrunAsNonRootuid other than 0. If this parameter isn’t specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.run_as_userINT64runAsUseruid). If this parameter isn’t specified, the default is the user that’s specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.volume_mountsUNORDERED_LIST_STRUCTvolumeMountsemptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.mount_pathSTRINGmountPathnameSTRINGnameread_onlyBOOLEANreadOnlytrue, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.sub_pathSTRINGsubPathmetadataSTRUCTmetadataannotationsMAP_STRING_STRINGannotationslabelsMAP_STRING_STRINGlabelsnamespaceSTRINGnamespacekube^a-z0-9?$kubernetesNamespace set in the compute environment’s EksConfiguration, but must have identical role-based access control (RBAC) roles as the compute environment’s kubernetesNamespace. For multi-node parallel jobs, the same value must be provided across all the node ranges.service_account_nameSTRINGserviceAccountNameshare_process_namespaceBOOLEANshareProcessNamespacevolumesUNORDERED_LIST_STRUCTvolumesempty_dirSTRUCTemptyDiremptyDir volume. For more information, see emptyDir in the Kubernetes documentation.mediumSTRINGmediumtmpfs volume that’s backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container’s memory limit.size_limitSTRINGsizeLimithost_pathSTRUCThostPathhostPath volume. For more information, see hostPath in the Kubernetes documentation.pathSTRINGpathnameSTRINGnamepersistent_volume_claimSTRUCTpersistentVolumeClaimpersistentVolumeClaim bounded to a persistentVolume. For more information, see Persistent Volume Claims in the Kubernetes documentation.claim_nameSTRINGclaimNamepersistentVolumeClaim bounded to a persistentVolume. For more information, see Persistent Volume Claims in the Kubernetes documentation.read_onlyBOOLEANreadOnlysecretSTRUCTsecretsecret volume. For more information, see secret in the Kubernetes documentation.optionalBOOLEANoptionalsecret_nameSTRINGsecretNamejob_definition_arnType: STRING
Provider name: jobDefinitionArn
Description: The Amazon Resource Name (ARN) for the job definition.
job_definition_nameType: STRING
Provider name: jobDefinitionName
Description: The name of the job definition.
node_propertiesType: STRUCT
Provider name: nodeProperties
Description: An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can’t be used in addition to containerProperties, ecsProperties, or eksProperties. nodeProperties. Use containerProperties instead.
main_nodeINT32mainNodenode_range_propertiesUNORDERED_LIST_STRUCTnodeRangePropertiesconsumable_resource_propertiesSTRUCTconsumableResourcePropertiesconsumable_resource_listUNORDERED_LIST_STRUCTconsumableResourceListconsumable_resourceSTRINGconsumableResourcequantityINT64quantitycontainerSTRUCTcontainercommandUNORDERED_LIST_STRINGcommandCmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.environmentUNORDERED_LIST_STRUCTenvironmentEnv in the Create a container section of the Docker Remote API and the –env option to docker run. AWS_BATCH”. This naming convention is reserved for variables that Batch sets.nameSTRINGnamevalueSTRINGvalueephemeral_storageSTRUCTephemeralStoragesize_in_gibINT32sizeInGiB21 GiB and the maximum supported value is 200 GiB.execution_role_arnSTRINGexecutionRoleArnfargate_platform_configurationSTRUCTfargatePlatformConfigurationplatform_versionSTRINGplatformVersionLATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.imageSTRINGimagerepository-url/image:tag . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest .123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).ubuntu or mongo).amazon/amazon-ecs-agent).quay.io/assemblyline/ubuntu).instance_typeSTRINGinstanceTypejob_role_arnSTRINGjobRoleArnlinux_parametersSTRUCTlinuxParametersdevicesUNORDERED_LIST_STRUCTdevicesDevices in the Create a container section of the Docker Remote API and the –device option to docker run. container_pathSTRINGcontainerPathhostPath value is used.host_pathSTRINGhostPathpermissionsUNORDERED_LIST_STRINGpermissionsread, write, and mknod for the device.init_process_enabledBOOLEANinitProcessEnabledinit process inside the container that forwards signals and reaps processes. This parameter maps to the –init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep “Server API version”max_swapINT32maxSwap–memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see –memory-swap details in the Docker documentation. If a maxSwap value of 0 is specified, the container doesn’t use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn’t use the swap configuration for the container instance that it’s running on. A maxSwap value must be set for the swappiness parameter to be used. shared_memory_sizeINT32sharedMemorySize/dev/shm volume. This parameter maps to the –shm-size option to docker run. swappinessINT32swappinessswappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn’t specified, a default value of 60 is used. If a value isn’t specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn’t use swap. This parameter maps to the –memory-swappiness option to docker run. Consider the following when you use a per-container swap configuration.maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.tmpfsUNORDERED_LIST_STRUCTtmpfstmpfs mount. This parameter maps to the –tmpfs option to docker run. container_pathSTRINGcontainerPathtmpfs volume is mounted.mount_optionsUNORDERED_LIST_STRINGmountOptionstmpfs volume mount options. Valid values: “defaults” | “ro” | “rw” | “suid” | “nosuid” | “dev” | “nodev” | “exec” | “noexec” | “sync” | “async” | “dirsync” | “remount” | “mand” | “nomand” | “atime” | “noatime” | “diratime” | “nodiratime” | “bind” | “rbind” | “unbindable” | “runbindable” | “private” | “rprivate” | “shared” | “rshared” | “slave” | “rslave” | “relatime” | “norelatime” | “strictatime” | “nostrictatime” | “mode” | “uid” | “gid” | “nr_inodes” | “nr_blocks” | “mpol"sizeINT32sizetmpfs volume.log_configurationSTRUCTlogConfigurationLogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. sudo docker version | grep “Server API version” ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.log_driverSTRINGlogDriverawslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk. awslogs and splunk log drivers.sudo docker version | grep “Server API version”optionsMAP_STRING_STRINGoptionssudo docker version | grep “Server API version”secret_optionsUNORDERED_LIST_STRUCTsecretOptionsnameSTRINGnamevalue_fromSTRINGvalueFrommemoryINT32memoryresourceRequirements to specify the memory requirements for the job definition. It’s not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it’s terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.mount_pointsUNORDERED_LIST_STRUCTmountPointsVolumes in the Create a container section of the Docker Remote API and the –volume option to docker run.container_pathSTRINGcontainerPathread_onlyBOOLEANreadOnlytrue, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.source_volumeSTRINGsourceVolumenetwork_configurationSTRUCTnetworkConfigurationassign_public_ipSTRINGassignPublicIpDISABLED”.privilegedBOOLEANprivilegedroot user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run. The default value is false. readonly_root_filesystemBOOLEANreadonlyRootFilesystemReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run.repository_credentialsSTRUCTrepositoryCredentialscredentials_parameterSTRINGcredentialsParameterresource_requirementsUNORDERED_LIST_STRUCTresourceRequirementsGPU, MEMORY, and VCPU.typeSTRINGtypeGPU, MEMORY, and VCPU.valueSTRINGvaluetype specified.Memory in the Create a container section of the Docker Remote API and the –memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run. value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.VCPU = 0.25VCPU = 0.25 or 0.5VCPU = 0.25, 0.5, or 1VCPU = 0.5, or 1VCPU = 0.5, 1, or 2VCPU = 1 or 2VCPU = 1, 2, or 4VCPU = 2 or 4VCPU = 2, 4, or 8VCPU = 4VCPU = 4 or 8VCPU = 8VCPU = 8 or 16VCPU = 16CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once. The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference. For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16MEMORY = 512, 1024, or 2048MEMORY = 1024, 2048, 3072, or 4096MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880runtime_platformSTRUCTruntimePlatformcpu_architectureSTRINGcpuArchitectureX86_64. Valid values are X86_64 and ARM64. X86_64 for Windows containers. ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.operating_system_familySTRINGoperatingSystemFamilyLINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL. linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration. LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found. ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.secretsUNORDERED_LIST_STRUCTsecretsnameSTRINGnamevalue_fromSTRINGvalueFromulimitsUNORDERED_LIST_STRUCTulimitsulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. hard_limitINT32hardLimitulimit type.nameSTRINGnametype of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.soft_limitINT32softLimitulimit type.userSTRINGuserUser in the Create a container section of the Docker Remote API and the –user option to docker run.vcpusINT32vcpusresourceRequirements to specify the vCPU requirements for the job definition. It’s not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.volumesUNORDERED_LIST_STRUCTvolumesefs_volume_configurationSTRUCTefsVolumeConfigurationplatformVersion of at least 1.4.0.authorization_configSTRUCTauthorizationConfigaccess_point_idSTRINGaccessPointIdEFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.iamSTRINGiamEFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.file_system_idSTRINGfileSystemIdroot_directorySTRINGrootDirectory/ has the same effect as omitting this parameter. The maximum length is 4,096 characters. authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.transit_encryptionSTRINGtransitEncryptionDISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.transit_encryption_portINT32transitEncryptionPorthostSTRUCThosthost parameter determine whether your data volume persists on the host container instance and where it’s stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn’t guaranteed to persist after the containers that are associated with it stop running. source_pathSTRINGsourcePathnameSTRINGnamesourceVolume parameter of container definition mountPoints.ecs_propertiesSTRUCTecsPropertiestask_propertiesUNORDERED_LIST_STRUCTtaskPropertiescontainersUNORDERED_LIST_STRUCTcontainerscommandUNORDERED_LIST_STRINGcommandCmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see Dockerfile reference: CMD.depends_onUNORDERED_LIST_STRUCTdependsOnconditionSTRINGconditionSTART - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can’t be set on an essential container.SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can’t be set on an essential container.container_nameSTRINGcontainerNameenvironmentUNORDERED_LIST_STRUCTenvironment–env parameter to docker run. AWS_BATCH. This naming convention is reserved for variables that Batch sets.nameSTRINGnamevalueSTRINGvalueessentialBOOLEANessentialtrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn’t affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All jobs must have at least one essential container. If you have an application that’s composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.imageSTRINGimagerepository-url/image:tag or repository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of the docker run .linux_parametersSTRUCTlinuxParametersdevicesUNORDERED_LIST_STRUCTdevicesDevices in the Create a container section of the Docker Remote API and the –device option to docker run. container_pathSTRINGcontainerPathhostPath value is used.host_pathSTRINGhostPathpermissionsUNORDERED_LIST_STRINGpermissionsread, write, and mknod for the device.init_process_enabledBOOLEANinitProcessEnabledinit process inside the container that forwards signals and reaps processes. This parameter maps to the –init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep “Server API version”max_swapINT32maxSwap–memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see –memory-swap details in the Docker documentation. If a maxSwap value of 0 is specified, the container doesn’t use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn’t use the swap configuration for the container instance that it’s running on. A maxSwap value must be set for the swappiness parameter to be used. shared_memory_sizeINT32sharedMemorySize/dev/shm volume. This parameter maps to the –shm-size option to docker run. swappinessINT32swappinessswappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn’t specified, a default value of 60 is used. If a value isn’t specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn’t use swap. This parameter maps to the –memory-swappiness option to docker run. Consider the following when you use a per-container swap configuration.maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.tmpfsUNORDERED_LIST_STRUCTtmpfstmpfs mount. This parameter maps to the –tmpfs option to docker run. container_pathSTRINGcontainerPathtmpfs volume is mounted.mount_optionsUNORDERED_LIST_STRINGmountOptionstmpfs volume mount options. Valid values: “defaults” | “ro” | “rw” | “suid” | “nosuid” | “dev” | “nodev” | “exec” | “noexec” | “sync” | “async” | “dirsync” | “remount” | “mand” | “nomand” | “atime” | “noatime” | “diratime” | “nodiratime” | “bind” | “rbind” | “unbindable” | “runbindable” | “private” | “rprivate” | “shared” | “rshared” | “slave” | “rslave” | “relatime” | “norelatime” | “strictatime” | “nostrictatime” | “mode” | “uid” | “gid” | “nr_inodes” | “nr_blocks” | “mpol"sizeINT32sizetmpfs volume.log_configurationSTRUCTlogConfigurationLogConfig in the Create a container section of the Docker Remote API and the –log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation. LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. –format ‘{{.Server.APIVersion}}’ ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.log_driverSTRINGlogDriverawslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk. awslogs and splunk log drivers.sudo docker version | grep “Server API version”optionsMAP_STRING_STRINGoptionssudo docker version | grep “Server API version”secret_optionsUNORDERED_LIST_STRUCTsecretOptionsnameSTRINGnamevalue_fromSTRINGvalueFrommount_pointsUNORDERED_LIST_STRUCTmountPointsVolumes in the Create a container section of the Docker Remote API and the –volume option to docker run. Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can’t mount directories on a different drive, and mount point can’t be across drives.container_pathSTRINGcontainerPathread_onlyBOOLEANreadOnlytrue, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.source_volumeSTRINGsourceVolumenameSTRINGnamedependsOn and Overrides objects.privilegedBOOLEANprivilegedtrue, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run. readonly_root_filesystemBOOLEANreadonlyRootFilesystemReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run. repository_credentialsSTRUCTrepositoryCredentialscredentials_parameterSTRINGcredentialsParameterresource_requirementsUNORDERED_LIST_STRUCTresourceRequirementstypeSTRINGtypeGPU, MEMORY, and VCPU.valueSTRINGvaluetype specified.Memory in the Create a container section of the Docker Remote API and the –memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run. value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.VCPU = 0.25VCPU = 0.25 or 0.5VCPU = 0.25, 0.5, or 1VCPU = 0.5, or 1VCPU = 0.5, 1, or 2VCPU = 1 or 2VCPU = 1, 2, or 4VCPU = 2 or 4VCPU = 2, 4, or 8VCPU = 4VCPU = 4 or 8VCPU = 8VCPU = 8 or 16VCPU = 16CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once. The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference. For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16MEMORY = 512, 1024, or 2048MEMORY = 1024, 2048, 3072, or 4096MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880secretsUNORDERED_LIST_STRUCTsecretsnameSTRINGnamevalue_fromSTRINGvalueFromulimitsUNORDERED_LIST_STRUCTulimitsulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version –format ‘{{.Server.APIVersion}}’ hard_limitINT32hardLimitulimit type.nameSTRINGnametype of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.soft_limitINT32softLimitulimit type.userSTRINGuserhost network mode, don’t run containers using the root user (UID 0). We recommend using a non-root user for better security. user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.useruser:groupuiduid:giduser:giuid:groupephemeral_storageSTRUCTephemeralStoragesize_in_gibINT32sizeInGiB21 GiB and the maximum supported value is 200 GiB.execution_role_arnSTRINGexecutionRoleArnipc_modeSTRINGipcModehost, task, or none. If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.network_configurationSTRUCTnetworkConfigurationassign_public_ipSTRINGassignPublicIpDISABLED”.pid_modeSTRINGpidModehost or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task. If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.platform_versionSTRINGplatformVersionLATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.runtime_platformSTRUCTruntimePlatformcpu_architectureSTRINGcpuArchitectureX86_64. Valid values are X86_64 and ARM64. X86_64 for Windows containers. ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.operating_system_familySTRINGoperatingSystemFamilyLINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL. linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration. LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found. ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.task_role_arnSTRINGtaskRoleArnvolumesUNORDERED_LIST_STRUCTvolumesefs_volume_configurationSTRUCTefsVolumeConfigurationplatformVersion of at least 1.4.0.authorization_configSTRUCTauthorizationConfigaccess_point_idSTRINGaccessPointIdEFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.iamSTRINGiamEFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.file_system_idSTRINGfileSystemIdroot_directorySTRINGrootDirectory/ has the same effect as omitting this parameter. The maximum length is 4,096 characters. authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.transit_encryptionSTRINGtransitEncryptionDISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.transit_encryption_portINT32transitEncryptionPorthostSTRUCThosthost parameter determine whether your data volume persists on the host container instance and where it’s stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn’t guaranteed to persist after the containers that are associated with it stop running. source_pathSTRINGsourcePathnameSTRINGnamesourceVolume parameter of container definition mountPoints.eks_propertiesSTRUCTeksPropertiespod_propertiesSTRUCTpodPropertiescontainersUNORDERED_LIST_STRUCTcontainersargsUNORDERED_LIST_STRINGargsCMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container’s environment. If the referenced environment variable doesn’t exist, the reference in the command isn’t changed. For example, if the reference is to “$(NAME1)” and the NAME1 environment variable doesn’t exist, the command string will remain “$(NAME1).” $$ is replaced with $, and the resulting string isn’t expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.commandUNORDERED_LIST_STRINGcommandENTRYPOINT of the container image is used. Environment variable references are expanded using the container’s environment. If the referenced environment variable doesn’t exist, the reference in the command isn’t changed. For example, if the reference is to “$(NAME1)” and the NAME1 environment variable doesn’t exist, the command string will remain “$(NAME1).” $$ is replaced with $ and the resulting string isn’t expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can’t be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.envUNORDERED_LIST_STRUCTenvAWS_BATCH”. This naming convention is reserved for variables that Batch sets.nameSTRINGnamevalueSTRINGvalueimageSTRINGimageimage_pull_policySTRINGimagePullPolicyAlways, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.nameSTRINGnameDefault” is used. Each container in a pod must have a unique name.resourcesSTRUCTresourcesmemory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.limitsMAP_STRING_STRINGlimitsname that’s specified. Resources can be requested using either the limits or the requests objects.memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that’s specified in limits must be equal to the value that’s specified in requests. 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that’s specified in limits must be at least as large as the value that’s specified in requests.memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that’s specified in limits must be equal to the value that’s specified in requests.requestsMAP_STRING_STRINGrequestsname that’s specified. Resources can be requested by using either the limits or the requests objects.memory can be specified in limits, requests, or both. If memory is specified in both, then the value that’s specified in limits must be equal to the value that’s specified in requests. 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that’s specified in limits must be at least as large as the value that’s specified in requests.nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that’s specified in limits must be equal to the value that’s specified in requests.security_contextSTRUCTsecurityContextallow_privilege_escalationBOOLEANallowPrivilegeEscalationfalse.privilegedBOOLEANprivilegedtrue, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.read_only_root_filesystemBOOLEANreadOnlyRootFilesystemtrue, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.run_as_groupINT64runAsGroupgid). If this parameter isn’t specified, the default is the group that’s specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.run_as_non_rootBOOLEANrunAsNonRootuid other than 0. If this parameter isn’t specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.run_as_userINT64runAsUseruid). If this parameter isn’t specified, the default is the user that’s specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.volume_mountsUNORDERED_LIST_STRUCTvolumeMountsemptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.mount_pathSTRINGmountPathnameSTRINGnameread_onlyBOOLEANreadOnlytrue, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.sub_pathSTRINGsubPathdns_policySTRINGdnsPolicyClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod’s DNS policy in the Kubernetes documentation. Valid values: Default | ClusterFirst | ClusterFirstWithHostNethost_networkBOOLEANhostNetworktrue. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don’t require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.image_pull_secretsUNORDERED_LIST_STRUCTimagePullSecretsImagePullSecret$name is required when this object is used.nameSTRINGnameImagePullSecret. This object is required when EksPodProperties$imagePullSecrets is used.init_containersUNORDERED_LIST_STRUCTinitContainersargsUNORDERED_LIST_STRINGargsCMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container’s environment. If the referenced environment variable doesn’t exist, the reference in the command isn’t changed. For example, if the reference is to “$(NAME1)” and the NAME1 environment variable doesn’t exist, the command string will remain “$(NAME1).” $$ is replaced with $, and the resulting string isn’t expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.commandUNORDERED_LIST_STRINGcommandENTRYPOINT of the container image is used. Environment variable references are expanded using the container’s environment. If the referenced environment variable doesn’t exist, the reference in the command isn’t changed. For example, if the reference is to “$(NAME1)” and the NAME1 environment variable doesn’t exist, the command string will remain “$(NAME1).” $$ is replaced with $ and the resulting string isn’t expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can’t be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.envUNORDERED_LIST_STRUCTenvAWS_BATCH”. This naming convention is reserved for variables that Batch sets.nameSTRINGnamevalueSTRINGvalueimageSTRINGimageimage_pull_policySTRINGimagePullPolicyAlways, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.nameSTRINGnameDefault” is used. Each container in a pod must have a unique name.resourcesSTRUCTresourcesmemory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.limitsMAP_STRING_STRINGlimitsname that’s specified. Resources can be requested using either the limits or the requests objects.memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that’s specified in limits must be equal to the value that’s specified in requests. 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that’s specified in limits must be at least as large as the value that’s specified in requests.memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that’s specified in limits must be equal to the value that’s specified in requests.requestsMAP_STRING_STRINGrequestsname that’s specified. Resources can be requested by using either the limits or the requests objects.memory can be specified in limits, requests, or both. If memory is specified in both, then the value that’s specified in limits must be equal to the value that’s specified in requests. 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that’s specified in limits must be at least as large as the value that’s specified in requests.nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that’s specified in limits must be equal to the value that’s specified in requests.security_contextSTRUCTsecurityContextallow_privilege_escalationBOOLEANallowPrivilegeEscalationfalse.privilegedBOOLEANprivilegedtrue, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.read_only_root_filesystemBOOLEANreadOnlyRootFilesystemtrue, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.run_as_groupINT64runAsGroupgid). If this parameter isn’t specified, the default is the group that’s specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.run_as_non_rootBOOLEANrunAsNonRootuid other than 0. If this parameter isn’t specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.run_as_userINT64runAsUseruid). If this parameter isn’t specified, the default is the user that’s specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.volume_mountsUNORDERED_LIST_STRUCTvolumeMountsemptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.mount_pathSTRINGmountPathnameSTRINGnameread_onlyBOOLEANreadOnlytrue, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.sub_pathSTRINGsubPathmetadataSTRUCTmetadataannotationsMAP_STRING_STRINGannotationslabelsMAP_STRING_STRINGlabelsnamespaceSTRINGnamespacekube^a-z0-9?$kubernetesNamespace set in the compute environment’s EksConfiguration, but must have identical role-based access control (RBAC) roles as the compute environment’s kubernetesNamespace. For multi-node parallel jobs, the same value must be provided across all the node ranges.service_account_nameSTRINGserviceAccountNameshare_process_namespaceBOOLEANshareProcessNamespacevolumesUNORDERED_LIST_STRUCTvolumesempty_dirSTRUCTemptyDiremptyDir volume. For more information, see emptyDir in the Kubernetes documentation.mediumSTRINGmediumtmpfs volume that’s backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container’s memory limit.size_limitSTRINGsizeLimithost_pathSTRUCThostPathhostPath volume. For more information, see hostPath in the Kubernetes documentation.pathSTRINGpathnameSTRINGnamepersistent_volume_claimSTRUCTpersistentVolumeClaimpersistentVolumeClaim bounded to a persistentVolume. For more information, see Persistent Volume Claims in the Kubernetes documentation.claim_nameSTRINGclaimNamepersistentVolumeClaim bounded to a persistentVolume. For more information, see Persistent Volume Claims in the Kubernetes documentation.read_onlyBOOLEANreadOnlysecretSTRUCTsecretsecret volume. For more information, see secret in the Kubernetes documentation.optionalBOOLEANoptionalsecret_nameSTRINGsecretNameinstance_typesUNORDERED_LIST_STRINGinstanceTypestarget_nodesSTRINGtargetNodes0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range properties override the 0:10 properties.num_nodesINT32numNodesparametersType: MAP_STRING_STRING
Provider name: parameters
Description: Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.
platform_capabilitiesType: UNORDERED_LIST_STRING
Provider name: platformCapabilities
Description: The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
propagate_tagsType: BOOLEAN
Provider name: propagateTags
Description: Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren’t propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
retry_strategyType: STRUCT
Provider name: retryStrategy
Description: The retry strategy to use for failed jobs that are submitted with this job definition.
attemptsINT32attemptsRUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.evaluate_on_exitUNORDERED_LIST_STRUCTevaluateOnExitattempts parameter must also be specified. If none of the listed conditions match, then the job is retried.actionSTRINGactiononStatusReason, onReason, and onExitCode) are met. The values aren’t case sensitive.on_exit_codeSTRINGonExitCodeExitCode returned for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match. The string can contain up to 512 characters.on_reasonSTRINGonReasonReason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.on_status_reasonSTRINGonStatusReasonStatusReason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.revisionType: INT32
Provider name: revision
Description: The revision of the job definition.
scheduling_priorityType: INT32
Provider name: schedulingPriority
Description: The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
statusType: STRING
Provider name: status
Description: The status of the job definition.
tagsType: UNORDERED_LIST_STRING
timeoutType: STRUCT
Provider name: timeout
Description: The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren’t finished.
attempt_duration_secondsINT32attemptDurationSecondsstartedAt timestamp. After this time passes, Batch terminates your jobs if they aren’t finished. The minimum value for the timeout is 60 seconds. For array jobs, the timeout applies to the child jobs, not to the parent array job. For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.typeType: STRING
Provider name: type
Description: The type of job definition. It’s either container or multinode. If the job is run on Fargate resources, then multinode isn’t supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
| |