Package software.amazon.awscdk.services.batch

Class EksContainerDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.batch.EksContainerDefinition

All Implemented Interfaces:

IEksContainerDefinition, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:03.380Z")
@Stability(Stable)
public class EksContainerDefinition
extends software.constructs.Construct
implements IEksContainerDefinition

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

Example:

 EksJobDefinition jobDefn = EksJobDefinition.Builder.create(this, "eksf2")
         .container(EksContainerDefinition.Builder.create(this, "container")
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .volumes(List.of(EksVolume.emptyDir(EmptyDirVolumeOptions.builder()
                         .name("myEmptyDirVolume")
                         .mountPath("/mount/path")
                         .medium(EmptyDirMediumType.MEMORY)
                         .readonly(true)
                         .sizeLimit(Size.mebibytes(2048))
                         .build())))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EksContainerDefinition.Builder	A fluent builder for EksContainerDefinition.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IEksContainerDefinition

IEksContainerDefinition.Jsii$Default, IEksContainerDefinition.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EksContainerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EksContainerDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	EksContainerDefinition(software.constructs.Construct scope, String id, EksContainerDefinitionProps props)

Method Summary

Modifier and Type	Method	Description
void	addVolume(EksVolume volume)	Mount a Volume to this container.
List<String>	getArgs()	An array of arguments to the entrypoint.
List<String>	getCommand()	The entrypoint for the container.
Number	getCpuLimit()	The hard limit of CPUs to present to this container.
Number	getCpuReservation()	The soft limit of CPUs to reserve for the container Must be an even multiple of 0.25.
Map<String,String>	getEnv()	The environment variables to pass to this container.
Number	getGpuLimit()	The hard limit of GPUs to present to this container.
Number	getGpuReservation()	The soft limit of CPUs to reserve for the container Must be an even multiple of 0.25.
ContainerImage	getImage()	The image that this container will run.
ImagePullPolicy	getImagePullPolicy()	The image pull policy for this container.
Size	getMemoryLimit()	The amount (in MiB) of memory to present to the container.
Size	getMemoryReservation()	The soft limit (in MiB) of memory to reserve for the container.
String	getName()	The name of this container.
Boolean	getPrivileged()	If specified, gives this container elevated permissions on the host container instance.
Boolean	getReadonlyRootFilesystem()	If specified, gives this container readonly access to its root file system.
Number	getRunAsGroup()	If specified, the container is run as the specified group ID (gid).
Boolean	getRunAsRoot()	If specified, the container is run as a user with a uid other than 0.
Number	getRunAsUser()	If specified, this container is run as the specified user ID (uid).
List<EksVolume>	getVolumes()	The Volumes to mount to this container.

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

EksContainerDefinition

protected EksContainerDefinition(software.amazon.jsii.JsiiObjectRef objRef)

EksContainerDefinition

protected EksContainerDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

EksContainerDefinition

@Stability(Stable)
public EksContainerDefinition(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 EksContainerDefinitionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

addVolume

@Stability(Stable)
public void addVolume(@NotNull
 EksVolume volume)

Mount a Volume to this container.

Automatically added to the Pod.

Specified by:

addVolume in interface IEksContainerDefinition

Parameters:

volume - This parameter is required.

getImage

@Stability(Stable)
@NotNull
public ContainerImage getImage()

The image that this container will run.

Specified by:

getImage in interface IEksContainerDefinition

getVolumes

@Stability(Stable)
@NotNull
public List<EksVolume> getVolumes()

The Volumes to mount to this container.

Automatically added to the Pod.

Specified by:

getVolumes in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/storage/volumes/

getArgs

@Stability(Stable)
@Nullable
public List<String> getArgs()

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. or example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists.

Specified by:

getArgs in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/

getCommand

@Stability(Stable)
@Nullable
public List<String> getCommand()

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.

Specified by:

getCommand in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint

getCpuLimit

@Stability(Stable)
@Nullable
public Number getCpuLimit()

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.

Specified by:

getCpuLimit in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

getCpuReservation

@Stability(Stable)
@Nullable
public Number getCpuReservation()

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.

Specified by:

getCpuReservation in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

getEnv

@Stability(Stable)
@Nullable
public Map<String,String> getEnv()

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.

Specified by:

getEnv in interface IEksContainerDefinition

getGpuLimit

@Stability(Stable)
@Nullable
public Number getGpuLimit()

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.

Specified by:

getGpuLimit in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

getGpuReservation

@Stability(Stable)
@Nullable
public Number getGpuReservation()

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.

Specified by:

getGpuReservation in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

getImagePullPolicy

@Stability(Stable)
@Nullable
public ImagePullPolicy getImagePullPolicy()

The image pull policy for this container.

Specified by:

getImagePullPolicy in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/containers/images/#updating-images

getMemoryLimit

@Stability(Stable)
@Nullable
public Size getMemoryLimit()

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

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.

Specified by:

getMemoryLimit in interface IEksContainerDefinition

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html

getMemoryReservation

@Stability(Stable)
@Nullable
public Size getMemoryReservation()

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

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.

Specified by:

getMemoryReservation in interface IEksContainerDefinition

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html

getName

@Stability(Stable)
@Nullable
public String getName()

The name of this container.

Specified by:

getName in interface IEksContainerDefinition

getPrivileged

@Stability(Stable)
@Nullable
public Boolean getPrivileged()

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

Specified by:

getPrivileged in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems

getReadonlyRootFilesystem

@Stability(Stable)
@Nullable
public Boolean getReadonlyRootFilesystem()

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

Specified by:

getReadonlyRootFilesystem in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems

getRunAsGroup

@Stability(Stable)
@Nullable
public Number getRunAsGroup()

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

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

Specified by:

getRunAsGroup in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups

getRunAsRoot

@Stability(Stable)
@Nullable
public Boolean getRunAsRoot()

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

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

Specified by:

getRunAsRoot in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups

getRunAsUser

@Stability(Stable)
@Nullable
public Number getRunAsUser()

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

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

Specified by:

getRunAsUser in interface IEksContainerDefinition

See Also:

• https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups