EksContainerDetail
The details for container properties that are returned by DescribeJobs
for jobs
that use Amazon EKS.
Contents
- args
-
An array of arguments to the entrypoint. If this isn't specified, the
CMD
of the container image is used. This corresponds to theargs
member in the Entrypointportion 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 theNAME1
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 theVAR_NAME
environment variable exists. For more information, see Dockerfile reference: CMDand Define a command and arguments for a pod in the Kubernetes documentation. Type: Array of strings
Required: No
- command
-
The entrypoint for the container. For more information, see Entrypoint
in the Kubernetes documentation. Type: Array of strings
Required: No
- env
-
The environment variables to pass to a container.
Note
Environment variables cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Amazon Batch sets.Type: Array of EksContainerEnvironmentVariable objects
Required: No
- exitCode
-
The exit code returned for the job attempt. A non-zero exit code is considered failed.
Type: Integer
Required: No
- image
-
The Docker image used to start the container.
Type: String
Required: No
- imagePullPolicy
-
The image pull policy for the container. Supported values are
Always
,IfNotPresent
, andNever
. This parameter defaults toAlways
if the:latest
tag is specified,IfNotPresent
otherwise. For more information, see Updating imagesin the Kubernetes documentation. Type: String
Required: No
- name
-
The name of the container. If the name isn't specified, the default name "
Default
" is used. Each container in a pod must have a unique name.Type: String
Required: No
- reason
-
A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.
Type: String
Required: No
- resources
-
The type and amount of resources to assign to a container. The supported resources include
memory
,cpu
, andnvidia.com/gpu
. For more information, see Resource management for pods and containersin the Kubernetes documentation. Type: EksContainerResourceRequirements object
Required: No
- securityContext
-
The security context for a job. For more information, see Configure a security context for a pod or container
in the Kubernetes documentation. Type: EksContainerSecurityContext object
Required: No
- volumeMounts
-
The volume mounts for the container. Amazon Batch supports
emptyDir
,hostPath
, andsecret
volume types. For more information about volumes and volume mounts in Kubernetes, see Volumesin the Kubernetes documentation. Type: Array of EksContainerVolumeMount objects
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: