aws-cdk-lib.aws_batch.IEksContainerDefinition

IEksContainerDefinition Interface

A container that can be run with EKS orchestration on EC2 resources.

IEksContainerDefinition

extends

• IConstruct

implemented by

• EksContainerDefinition

Source

aws-batch/lib/eks-container-definition.ts

Type last changed

v2.96.0 · 13 Sep 2023

Properties

args?may be undefinedstring[]args?may be undefinedtyping.List[str]args?may be undefinedList<String>Args?may be undefinedstring[]Args?may be undefined*[]*string#

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 "$(NAME1)"andtheNAME1environmentvariabledoes{n}^{\prime }texist,thecommandstringwillremain"$(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.

command?may be undefinedstring[]command?may be undefinedtyping.List[str]command?may be undefinedList<String>Command?may be undefinedstring[]Command?may be undefined*[]*string#

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.

cpuLimit?may be undefinednumbercpu_limit?may be undefinedint | floatcpuLimit?may be undefinedNumberCpuLimit?may be undefineddoubleCpuLimit?may be undefined*float64#

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

Default: No CPU limit

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.

cpuReservation?may be undefinednumbercpu_reservation?may be undefinedint | floatcpuReservation?may be undefinedNumberCpuReservation?may be undefineddoubleCpuReservation?may be undefined*float64#

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

Default: No CPUs reserved

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?may be undefined{ [key: string]: string }env?may be undefinedtyping.Mapping[str, str]env?may be undefinedMap<String, String>Env?may be undefinedIDictionary<string, string>Env?may be undefined*map[string]*string#

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.

gpuLimit?may be undefinednumbergpu_limit?may be undefinedint | floatgpuLimit?may be undefinedNumberGpuLimit?may be undefineddoubleGpuLimit?may be undefined*float64#

The hard limit of GPUs to present to this container.

Default: No GPU limit

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.

gpuReservation?may be undefinednumbergpu_reservation?may be undefinedint | floatgpuReservation?may be undefinedNumberGpuReservation?may be undefineddoubleGpuReservation?may be undefined*float64#

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

Default: No GPUs reserved

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.

imagePullPolicy?may be undefinedImagePullPolicyimage_pull_policy?may be undefinedImagePullPolicyimagePullPolicy?may be undefinedImagePullPolicyImagePullPolicy?may be undefinedImagePullPolicyImagePullPolicy?may be undefinedImagePullPolicy#

The image pull policy for this container.

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

memoryLimit?may be undefinedSizememory_limit?may be undefinedSizememoryLimit?may be undefinedSizeMemoryLimit?may be undefinedSizeMemoryLimit?may be undefinedSize#

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

Default: No memory limit

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.

memoryReservation?may be undefinedSizememory_reservation?may be undefinedSizememoryReservation?may be undefinedSizeMemoryReservation?may be undefinedSizeMemoryReservation?may be undefinedSize#

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

Default: No memory reserved

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.

name?may be undefinedstringname?may be undefinedstrname?may be undefinedStringName?may be undefinedstringName?may be undefined*string#

The name of this container.

Default: : 'Default'

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

privileged?may be undefinedbooleanprivileged?may be undefinedboolprivileged?may be undefinedBooleanPrivileged?may be undefinedboolPrivileged?may be undefined*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.

Note: this is only compatible with Kubernetes < v1.25

readonlyRootFilesystem?may be undefinedbooleanreadonly_root_filesystem?may be undefinedboolreadonlyRootFilesystem?may be undefinedBooleanReadonlyRootFilesystem?may be undefinedboolReadonlyRootFilesystem?may be undefined*bool= false#

If specified, gives this container readonly access to its root file system.

This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.

Note: this is only compatible with Kubernetes < v1.25

runAsGroup?may be undefinednumberrun_as_group?may be undefinedint | floatrunAsGroup?may be undefinedNumberRunAsGroup?may be undefineddoubleRunAsGroup?may be undefined*float64= none#

If specified, the container is run as the specified group ID (`gid`).

notes

If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

Note: this is only compatible with Kubernetes < v1.25

runAsRoot?may be undefinedbooleanrun_as_root?may be undefinedboolrunAsRoot?may be undefinedBooleanRunAsRoot?may be undefinedboolRunAsRoot?may be undefined*bool#

If specified, the container is run as a user with a `uid` other than 0.

Default: the container is not required to run as a non-root user

Otherwise, no such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.

Note: this is only compatible with Kubernetes < v1.25

runAsUser?may be undefinednumberrun_as_user?may be undefinedint | floatrunAsUser?may be undefinedNumberRunAsUser?may be undefineddoubleRunAsUser?may be undefined*float64#

If specified, this container is run as the specified user ID (`uid`).

Default: the user that is specified in the image metadata.

This parameter maps to RunAsUser and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

Note: this is only compatible with Kubernetes < v1.25

volumesEksVolume[]volumestyping.List[EksVolume]volumesList<EksVolume>VolumesEksVolume[]Volumes*[]EksVolumerequired#

The Volumes to mount to this container.

Automatically added to the Pod.

Methods

addVolume(volume: EksVolume): voiddef add_volume(self, volume: EksVolume) -> Nonepublic void addVolume(EksVolume volume)public void AddVolume(EksVolume volume)func AddVolume(Volume EksVolume)#

Mount a Volume to this container.

Automatically added to the Pod.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining