AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Register-BATJobDefinition-JobDefinitionName <String>-NetworkConfiguration_AssignPublicIp <AssignPublicIp>-RetryStrategy_Attempt <Int32>-ContainerProperties_Command <String[]>-LinuxParameters_Device <Device[]>-ContainerProperties_Environment <KeyValuePair[]>-RetryStrategy_EvaluateOnExit <EvaluateOnExit[]>-ContainerProperties_ExecutionRoleArn <String>-ContainerProperties_Image <String>-LinuxParameters_InitProcessEnabled <Boolean>-ContainerProperties_InstanceType <String>-ContainerProperties_JobRoleArn <String>-LogConfiguration_LogDriver <LogDriver>-NodeProperties_MainNode <Int32>-LinuxParameters_MaxSwap <Int32>-ContainerProperties_MountPoint <MountPoint[]>-NodeProperties_NodeRangeProperty <NodeRangeProperty[]>-NodeProperties_NumNode <Int32>-LogConfiguration_Option <Hashtable>-Parameter <Hashtable>-PlatformCapability <String[]>-FargatePlatformConfiguration_PlatformVersion <String>-ContainerProperties_Privileged <Boolean>-PropagateTag <Boolean>-ContainerProperties_ReadonlyRootFilesystem <Boolean>-ContainerProperties_ResourceRequirement <ResourceRequirement[]>-SchedulingPriority <Int32>-LogConfiguration_SecretOption <Secret[]>-ContainerProperties_Secret <Secret[]>-LinuxParameters_SharedMemorySize <Int32>-LinuxParameters_Swappiness <Int32>-Tag <Hashtable>-Timeout <JobTimeout>-LinuxParameters_Tmpf <Tmpfs[]>-Type <JobDefinitionType>-ContainerProperties_Ulimit <Ulimit[]>-ContainerProperties_User <String>-ContainerProperties_Volume <Volume[]>-ContainerProperties_Memory <Int32>-ContainerProperties_Vcpus <Int32>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
Cmd
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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Env
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 are set by the Batch service. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
repository-url/image:tag
. 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 docker run.Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.registry/repository[:tag]
or registry/repository[@digest]
naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest
.012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>
).ubuntu
or mongo
).amazon/amazon-ecs-agent
).quay.io/assemblyline/ubuntu
).Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
resourceRequirements
to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on 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.This parameter is deprecated. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker run. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_MountPoints |
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. The default value is false.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to docker run
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
GPU
, MEMORY
, and VCPU
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_ResourceRequirements |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_Secrets |
ulimits
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.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_Ulimits |
User
in the Create a container section of the Docker Remote API and the --user
option to docker run. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
resourceRequirements
to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on 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.This parameter is deprecated. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_Volumes |
LATEST
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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_FargatePlatformConfiguration_PlatformVersion |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Devices
in the Create a container section of the Docker Remote API and the --device
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LinuxParameters_Devices |
init
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 into your container instance and run the following command: sudo docker version | grep "Server API version"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LinuxParameters_InitProcessEnabled |
--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 it is running on. A maxSwap
value must be set for the swappiness
parameter to be used.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LinuxParameters_MaxSwap |
/dev/shm
volume. This parameter maps to the --shm-size
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LinuxParameters_SharedMemorySize |
swappiness
value of 0
causes swapping not to happen unless absolutely necessary. A swappiness
value of 100
causes pages to be swapped very aggressively. Accepted 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 will have a default swappiness
value of 60, and the total swap usage will be limited to two times the memory reservation of the container.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LinuxParameters_Swappiness |
--tmpfs
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LinuxParameters_Tmpfs |
awslogs
, fluentd
, gelf
, json-file
, journald
, logentries
, syslog
, and splunk
.Jobs that are running on Fargate resources are restricted to the awslogs
and splunk
log drivers.sudo docker version | grep "Server API version"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LogConfiguration_LogDriver |
sudo docker version | grep "Server API version"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LogConfiguration_Options |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_LogConfiguration_SecretOptions |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerProperties_NetworkConfiguration_AssignPublicIp |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NodeProperties_NodeRangeProperties |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NodeProperties_NumNodes |
SubmitJob
request override any corresponding parameter defaults from the job definition. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Parameters |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
EC2
. To run the job on Fargate resources, specify FARGATE
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PlatformCapabilities |
FAILED
state. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PropagateTags |
RUNNABLE
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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RetryStrategy_Attempts |
attempts
parameter must also be specified. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
multinode
isn't supported. Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z