/AWS1/CL_BTCEKSCONTAINER

EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_image TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The Docker image used to start the container.

Optional arguments:

iv_name TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

iv_imagepullpolicy TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The image pull policy for the container. Supported values are Always, 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.

it_command TYPE /AWS1/CL_BTCSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT 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.

it_args TYPE /AWS1/CL_BTCSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

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 Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

it_env TYPE /AWS1/CL_BTCEKSCONTAINERENVI00=>TT_EKSCONTAINERENVIRONMENTVA00 TT_EKSCONTAINERENVIRONMENTVA00

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.

io_resources TYPE REF TO /AWS1/CL_BTCEKSCONTAINERRESR00 /AWS1/CL_BTCEKSCONTAINERRESR00

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.

it_volumemounts TYPE /AWS1/CL_BTCEKSCONTAINERVOLM00=>TT_EKSCONTAINERVOLUMEMOUNTS TT_EKSCONTAINERVOLUMEMOUNTS

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.

io_securitycontext TYPE REF TO /AWS1/CL_BTCEKSCONTAINERSECCTX /AWS1/CL_BTCEKSCONTAINERSECCTX

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

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

image

The Docker image used to start the container.

Accessible with the following methods

Method	Description
GET_IMAGE()	Getter for IMAGE, with configurable default
ASK_IMAGE()	Getter for IMAGE w/ exceptions if field has no value
HAS_IMAGE()	Determine if IMAGE has a value

imagePullPolicy

The image pull policy for the container. Supported values are Always, 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.

Accessible with the following methods

Method	Description
GET_IMAGEPULLPOLICY()	Getter for IMAGEPULLPOLICY, with configurable default
ASK_IMAGEPULLPOLICY()	Getter for IMAGEPULLPOLICY w/ exceptions if field has no val
HAS_IMAGEPULLPOLICY()	Determine if IMAGEPULLPOLICY has a value

command

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT 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.

Accessible with the following methods

Method	Description
GET_COMMAND()	Getter for COMMAND, with configurable default
ASK_COMMAND()	Getter for COMMAND w/ exceptions if field has no value
HAS_COMMAND()	Determine if COMMAND has a value

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 Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

Accessible with the following methods

Method	Description
GET_ARGS()	Getter for ARGS, with configurable default
ASK_ARGS()	Getter for ARGS w/ exceptions if field has no value
HAS_ARGS()	Determine if ARGS has a value

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.

Accessible with the following methods

Method	Description
GET_ENV()	Getter for ENV, with configurable default
ASK_ENV()	Getter for ENV w/ exceptions if field has no value
HAS_ENV()	Determine if ENV has a value

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.

Accessible with the following methods

Method	Description
GET_RESOURCES()	Getter for RESOURCES

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.

Accessible with the following methods

Method	Description
GET_VOLUMEMOUNTS()	Getter for VOLUMEMOUNTS, with configurable default
ASK_VOLUMEMOUNTS()	Getter for VOLUMEMOUNTS w/ exceptions if field has no value
HAS_VOLUMEMOUNTS()	Determine if VOLUMEMOUNTS has a value

securityContext

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

Accessible with the following methods

Method	Description
GET_SECURITYCONTEXT()	Getter for SECURITYCONTEXT

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_EKSCONTAINERS

TYPES TT_EKSCONTAINERS TYPE STANDARD TABLE OF REF TO /AWS1/CL_BTCEKSCONTAINER WITH DEFAULT KEY
.