EksContainerDefinitionProps Struct

Props to configure an EksContainerDefinition.

Source: aws-batch/lib/eks-container-definition.ts
Type last changed: v2.96.0 · 13 Sep 2023

Example

const jobDefn = new batch.EksJobDefinition(this, 'eksf2', {
  container: new batch.EksContainerDefinition(this, 'container', {
    image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
    volumes: [batch.EksVolume.emptyDir({
      name: 'myEmptyDirVolume',
      mountPath: '/mount/path',
      medium: batch.EmptyDirMediumType.MEMORY,
      readonly: true,
      sizeLimit: cdk.Size.mebibytes(2048),
    })],
  }),
});

Properties

argsstring[]argstyping.List[str]argsList<String>Argsstring[]Args*[]*string= no args#

An array of arguments to the entrypoint.

notes

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 " $(N A M E 1) " a n d t h e N A M E 1 e n v i r o n m e n t v a r i a b l e d o e s n^{'} t e x i s t, t h e c o m m a n d s t r i n g w i l l r e m a i n "$ (NAME1)." $$ is replaced with $, and the resulting string isn't expanded. or example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists.

commandstring[]commandtyping.List[str]commandList<String>Commandstring[]Command*[]*string= no command#

The entrypoint for the container.

notes

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.

cpuLimitnumbercpu_limitint | floatcpuLimitNumberCpuLimitdoubleCpuLimit*float64= No CPU limit#

The hard limit of CPUs to present to this container. Must be an even multiple of 0.25.

If your container attempts to exceed this limit, it will be terminated.

At least one of cpuReservation and cpuLimit is required. If both are specified, then cpuLimit must be at least as large as cpuReservation.

cpuReservationnumbercpu_reservationint | floatcpuReservationNumberCpuReservationdoubleCpuReservation*float64= No CPUs reserved#

The soft limit of CPUs to reserve for the container Must be an even multiple of 0.25.

The container will given at least this many CPUs, but may consume more.

At least one of cpuReservation and cpuLimit is required. If both are specified, then cpuLimit must be at least as large as cpuReservation.

env{ [key: string]: string }envtyping.Mapping[str, str]envMap<String, String>EnvIDictionary<string, string>Env*map[string]*string= no environment variables#

The environment variables to pass to this container.

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

gpuLimitnumbergpu_limitint | floatgpuLimitNumberGpuLimitdoubleGpuLimit*float64= No GPU limit#

The hard limit of GPUs to present to this container.

If your container attempts to exceed this limit, it will be terminated.

If both gpuReservation and gpuLimit are specified, then gpuLimit must be equal to gpuReservation.

gpuReservationnumbergpu_reservationint | floatgpuReservationNumberGpuReservationdoubleGpuReservation*float64= No GPUs reserved#

The soft limit of CPUs to reserve for the container Must be an even multiple of 0.25.

The container will given at least this many CPUs, but may consume more.

If both gpuReservation and gpuLimit are specified, then gpuLimit must be equal to gpuReservation.

imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImagerequired#

The image that this container will run.

imagePullPolicyImagePullPolicyimage_pull_policyImagePullPolicyimagePullPolicyImagePullPolicyImagePullPolicyImagePullPolicyImagePullPolicyImagePullPolicy= `ALWAYS` if the `:latest` tag is…#

The image pull policy for this container.

default

Default: ALWAYS if the :latest tag is specified, IF_NOT_PRESENT otherwise

memoryLimitSizememory_limitSizememoryLimitSizeMemoryLimitSizeMemoryLimitSize= No memory limit#

The amount (in MiB) of memory to present to the container.

notes

If your container attempts to exceed the allocated memory, it will be terminated.

Must be larger that 4 MiB

At least one of memoryLimit and memoryReservation is required

Note: To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using.

memoryReservationSizememory_reservationSizememoryReservationSizeMemoryReservationSizeMemoryReservationSize= No memory reserved#

The soft limit (in MiB) of memory to reserve for the container.

notes

Your container will be given at least this much memory, but may consume more.

Must be larger that 4 MiB

When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.

At least one of memoryLimit and memoryReservation is required. If both are specified, then memoryLimit must be equal to memoryReservation

Note: To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using.

namestringnamestrnameStringNamestringName*string= : `'Default'`#

The name of this container.

privilegedbooleanprivilegedboolprivilegedBooleanPrivilegedboolPrivileged*bool= false#

If specified, gives this container elevated permissions on the host container instance.

The level of permissions are similar to the root user permissions.

This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.