Package software.amazon.awscdk.services.batch

Class EcsEc2ContainerDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.batch.EcsEc2ContainerDefinition

All Implemented Interfaces:

IEcsContainerDefinition, IEcsEc2ContainerDefinition, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:05.472Z")
@Stability(Stable)
public class EcsEc2ContainerDefinition
extends software.constructs.Construct
implements IEcsEc2ContainerDefinition, IEcsContainerDefinition

A container orchestrated by ECS that uses EC2 resources.

Example:

 IFileSystem myFileSystem;
 Role myJobRole;
 myFileSystem.grantRead(myJobRole);
 EcsJobDefinition jobDefn = EcsJobDefinition.Builder.create(this, "JobDefn")
         .container(EcsEc2ContainerDefinition.Builder.create(this, "containerDefn")
                 .image(ContainerImage.fromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"))
                 .memory(Size.mebibytes(2048))
                 .cpu(256)
                 .volumes(List.of(EcsVolume.efs(EfsVolumeOptions.builder()
                         .name("myVolume")
                         .fileSystem(myFileSystem)
                         .containerPath("/Volumes/myVolume")
                         .useJobRole(true)
                         .build())))
                 .jobRole(myJobRole)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

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.IEcsContainerDefinition

IEcsContainerDefinition.Jsii$Default, IEcsContainerDefinition.Jsii$Proxy

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

IEcsEc2ContainerDefinition.Jsii$Default, IEcsEc2ContainerDefinition.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addUlimit(Ulimit ulimit)	Add a ulimit to this container.
void	addVolume(EcsVolume volume)	Add a Volume to this container.
List<String>	getCommand()	The command that's passed to the container.
Number	getCpu()	The number of vCPUs reserved for the container.
Boolean	getEnableExecuteCommand()	Whether to enable ecs exec for this container.
Map<String,String>	getEnvironment()	The environment variables to pass to a container.
IRole	getExecutionRole()	The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.
Number	getGpu()	The number of physical GPUs to reserve for the container.
ContainerImage	getImage()	The image that this container will run.
IRole	getJobRole()	The role that the container can assume.
LinuxParameters	getLinuxParameters()	Linux-specific modifications that are applied to the container, such as details for device mappings.
LogDriverConfig	getLogDriverConfig()	The configuration of the log driver.
Size	getMemory()	The memory hard limit present to the container.
Boolean	getPrivileged()	When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user).
Boolean	getReadonlyRootFilesystem()	Gives the container readonly access to its root filesystem.
Map<String,Secret>	getSecrets()	A map from environment variable names to the secrets for the container.
List<Ulimit>	getUlimits()	Limits to set for the user this docker container will run as.
String	getUser()	The user name to use inside the container.
List<EcsVolume>	getVolumes()	The volumes to mount to this container.

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString, with

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, with

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

EcsEc2ContainerDefinition

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

EcsEc2ContainerDefinition

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

EcsEc2ContainerDefinition

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

addUlimit

@Stability(Stable)
public void addUlimit(@NotNull
 Ulimit ulimit)

Add a ulimit to this container.

Specified by:

addUlimit in interface IEcsEc2ContainerDefinition

Parameters:

ulimit - This parameter is required.

addVolume

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

Add a Volume to this container.

Specified by:

addVolume in interface IEcsContainerDefinition

Parameters:

volume - This parameter is required.

getCpu

@Stability(Stable)
@NotNull
public Number getCpu()

The number of vCPUs reserved for the container.

Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.

Specified by:

getCpu in interface IEcsContainerDefinition

getExecutionRole

@Stability(Stable)
@NotNull
public IRole getExecutionRole()

The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.

Specified by:

getExecutionRole in interface IEcsContainerDefinition

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html

getImage

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

The image that this container will run.

Specified by:

getImage in interface IEcsContainerDefinition

getMemory

@Stability(Stable)
@NotNull
public Size getMemory()

The memory hard limit present to the container.

If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job.

Specified by:

getMemory in interface IEcsContainerDefinition

getUlimits

@Stability(Stable)
@NotNull
public List<Ulimit> getUlimits()

Limits to set for the user this docker container will run as.

Specified by:

getUlimits in interface IEcsEc2ContainerDefinition

getVolumes

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

The volumes to mount to this container.

Automatically added to the job definition.

Specified by:

getVolumes in interface IEcsContainerDefinition

getCommand

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

The command that's passed to the container.

Specified by:

getCommand in interface IEcsContainerDefinition

See Also:

• https://docs.docker.com/engine/reference/builder/#cmd

getEnableExecuteCommand

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

Whether to enable ecs exec for this container.

Specified by:

getEnableExecuteCommand in interface IEcsContainerDefinition

getEnvironment

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

The environment variables to pass to a container.

Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Specified by:

getEnvironment in interface IEcsContainerDefinition

getGpu

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

The number of physical GPUs to reserve for the container.

Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

Specified by:

getGpu in interface IEcsEc2ContainerDefinition

getJobRole

@Stability(Stable)
@Nullable
public IRole getJobRole()

The role that the container can assume.

Specified by:

getJobRole in interface IEcsContainerDefinition

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html

getLinuxParameters

@Stability(Stable)
@Nullable
public LinuxParameters getLinuxParameters()

Linux-specific modifications that are applied to the container, such as details for device mappings.

Specified by:

getLinuxParameters in interface IEcsContainerDefinition

getLogDriverConfig

@Stability(Stable)
@Nullable
public LogDriverConfig getLogDriverConfig()

The configuration of the log driver.

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition

getPrivileged

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

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user).

Specified by:

getPrivileged in interface IEcsEc2ContainerDefinition

getReadonlyRootFilesystem

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

Gives the container readonly access to its root filesystem.

Specified by:

getReadonlyRootFilesystem in interface IEcsContainerDefinition

getSecrets

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

A map from environment variable names to the secrets for the container.

Allows your job definitions to reference the secret by the environment variable name defined in this property.

Specified by:

getSecrets in interface IEcsContainerDefinition

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html

getUser

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

The user name to use inside the container.

Specified by:

getUser in interface IEcsContainerDefinition