aws-cdk-lib.aws_batch.IEcsContainerDefinition

IEcsContainerDefinition Interface

A container that can be run with ECS orchestration.

IEcsContainerDefinition

extends

• IConstruct

implemented by

• EcsEc2ContainerDefinition,
• EcsFargateContainerDefinition

Source

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

Type last changed

v2.215.0 · 15 Sep 2025

Properties

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 command that's passed to the container.

cpunumbercpuint | floatcpuNumberCpudoubleCpu*float64required#

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.

enableExecuteCommand?may be undefinedbooleanenable_execute_command?may be undefinedboolenableExecuteCommand?may be undefinedBooleanEnableExecuteCommand?may be undefinedboolEnableExecuteCommand?may be undefined*bool#

Whether to enable ecs exec for this container.

Default: undefined - AWS Batch default is false

environment?may be undefined{ [key: string]: string }environment?may be undefinedtyping.Mapping[str, str]environment?may be undefinedMap<String, String>Environment?may be undefinedIDictionary<string, string>Environment?may be undefined*map[string]*string#

The environment variables to pass to a container.

Default: no environment variables

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

executionRoleIRoleexecution_roleIRoleexecutionRoleIRoleExecutionRoleIRoleExecutionRoleIRolerequired#

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

imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImagerequired#

The image that this container will run.

jobRole?may be undefinedIRolejob_role?may be undefinedIRolejobRole?may be undefinedIRoleJobRole?may be undefinedIRoleJobRole?may be undefinedIRole#

The role that the container can assume.

Default: no jobRole

linuxParameters?may be undefinedLinuxParameterslinux_parameters?may be undefinedLinuxParameterslinuxParameters?may be undefinedLinuxParametersLinuxParameters?may be undefinedLinuxParametersLinuxParameters?may be undefinedLinuxParameters= none#

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

logDriverConfig?may be undefinedLogDriverConfiglog_driver_config?may be undefinedLogDriverConfiglogDriverConfig?may be undefinedLogDriverConfigLogDriverConfig?may be undefinedLogDriverConfigLogDriverConfig?may be undefinedLogDriverConfig#

The configuration of the log driver.

memorySizememorySizememorySizeMemorySizeMemorySizerequired#

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

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

Gives the container readonly access to its root filesystem.

secrets?may be undefined{ [key: string]: Secret }secrets?may be undefinedtyping.Mapping[str, Secret]secrets?may be undefinedMap<String, Secret>Secrets?may be undefinedIDictionary<string, Secret>Secrets?may be undefined*map[string]Secret#

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

Default: no secrets

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

user?may be undefinedstringuser?may be undefinedstruser?may be undefinedStringUser?may be undefinedstringUser?may be undefined*string#

The user name to use inside the container.

Default: no user

volumesEcsVolume[]volumestyping.List[EcsVolume]volumesList<EcsVolume>VolumesEcsVolume[]Volumes*[]EcsVolumerequired#

The volumes to mount to this container.

Default: no volumes

Automatically added to the job definition.

Methods

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

Add a Volume to this container.

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