Documentation

The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.

See: newEksContainerDetail smart constructor.

Create a value of EksContainerDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:args:EksContainerDetail', eksContainerDetail_args - An array of arguments to the entrypoint. If this isn't specified, the CMD 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 CMD in the Dockerfile reference and Define a command and arguments for a pod in the Kubernetes documentation.

$sel:command:EksContainerDetail', eksContainerDetail_command - The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.

$sel:env:EksContainerDetail', eksContainerDetail_env - The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

$sel:exitCode:EksContainerDetail', eksContainerDetail_exitCode - The exit code for the job attempt. A non-zero exit code is considered failed.

$sel:image:EksContainerDetail', eksContainerDetail_image - The Docker image used to start the container.

$sel:imagePullPolicy:EksContainerDetail', eksContainerDetail_imagePullPolicy - The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

EksContainerDetail, eksContainerDetail_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.

$sel:reason:EksContainerDetail', eksContainerDetail_reason - A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

$sel:resources:EksContainerDetail', eksContainerDetail_resources - The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

$sel:securityContext:EksContainerDetail', eksContainerDetail_securityContext - The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

$sel:volumeMounts:EksContainerDetail', eksContainerDetail_volumeMounts - The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

An array of arguments to the entrypoint. If this isn't specified, the CMD 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 CMD in the Dockerfile reference and Define a command and arguments for a pod in the Kubernetes documentation.

The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.

The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

The exit code for the job attempt. A non-zero exit code is considered failed.

The Docker image used to start the container.

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

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.

A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.