Package software.amazon.awscdk.services.batch

Interface EksContainerDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EksContainerDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:34.456Z")
@Stability(Stable)
public interface EksContainerDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Props to configure an EksContainerDefinition.

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	Interface	Description
static final class	EksContainerDefinitionProps.Builder	A builder for EksContainerDefinitionProps
static final class	EksContainerDefinitionProps.Jsii$Proxy	An implementation for EksContainerDefinitionProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImage

@Stability(Stable)
@NotNull
ContainerImage getImage()

The image that this container will run.

getArgs

@Stability(Stable)
@Nullable
default 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.

Default: - no args

See Also:

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

getCommand

@Stability(Stable)
@Nullable
default 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.

Default: - no command

See Also:

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

getCpuLimit

@Stability(Stable)
@Nullable
default 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.

Default: - No CPU limit

See Also:

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

getCpuReservation

@Stability(Stable)
@Nullable
default 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.

Default: - No CPUs reserved

See Also:

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

getEnv

@Stability(Stable)
@Nullable
default 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.

Default: - no environment variables

getGpuLimit

@Stability(Stable)
@Nullable
default 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.

Default: - No GPU limit

See Also:

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

getGpuReservation

@Stability(Stable)
@Nullable
default 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.

Default: - No GPUs reserved

See Also:

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

getImagePullPolicy

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

The image pull policy for this container.

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

See Also:

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

getMemoryLimit

@Stability(Stable)
@Nullable
default 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.

Default: - No memory limit

See Also:

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

getMemoryReservation

@Stability(Stable)
@Nullable
default 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.

Default: - No memory reserved

See Also:

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

getName

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

The name of this container.

Default: : `'Default'`

getPrivileged

@Stability(Stable)
@Nullable
default 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

Default: false

See Also:

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

getReadonlyRootFilesystem

@Stability(Stable)
@Nullable
default 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

Default: false

See Also:

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

getRunAsGroup

@Stability(Stable)
@Nullable
default 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

Default: none

See Also:

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

getRunAsRoot

@Stability(Stable)
@Nullable
default 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

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

See Also:

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

getRunAsUser

@Stability(Stable)
@Nullable
default 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

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

See Also:

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

getVolumes

@Stability(Stable)
@Nullable
default List<EksVolume> getVolumes()

The Volumes to mount to this container.

Automatically added to the Pod.

Default: - no volumes

See Also:

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

builder

@Stability(Stable)
static EksContainerDefinitionProps.Builder builder()

Returns:

a EksContainerDefinitionProps.Builder of EksContainerDefinitionProps