ContainerOverrides
The overrides that should be sent to a container.
Contents
- command
-
The command to send to the container that overrides the default command from the Docker image or the job definition.
Type: Array of strings
Required: No
- environment
-
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.
Note Environment variables must not start with
AWS_BATCH
; this naming convention is reserved for variables that are set by the AWS Batch service.Type: Array of KeyValuePair objects
Required: No
- instanceType
-
The instance type to use for a multi-node parallel job.
Note This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
Type: String
Required: No
- memory
-
This member has been deprecated.
This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the
memory
parameter set in the job definition, but doesn't override any memory requirement specified in theResourceRequirement
structure in the job definition. In order to override memory requirements specified in theResourceRequirement
structure in the job definition,ResourceRequirement
must be specified in theSubmitJob
request, withtype
set toMEMORY
andvalue
set to the new value.This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use
resourceRequirement
instead.Type: Integer
Required: No
- resourceRequirements
-
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include
GPU
,MEMORY
, andVCPU
.Type: Array of ResourceRequirement objects
Required: No
- vcpus
-
This member has been deprecated.
This parameter indicates the number of vCPUs reserved for the container.It overrides the
vcpus
parameter that's set in the job definition, but doesn't override any vCPU requirement specified in theresourceRequirement
structure in the job definition. In order to override vCPU requirements specified in theResourceRequirement
structure in the job definition,ResourceRequirement
must be specified in theSubmitJob
request, withtype
set toVCPU
andvalue
set to the new value.This parameter maps to
CpuShares
in the Create a containersection of the Docker Remote API and the --cpu-shares
option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. Note This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use
resourceRequirement
. For EC2 resources, you can use either this parameter orresourceRequirement
but not both.Type: Integer
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: