aws-cdk-lib.aws_batch.EcsFargateContainerDefinition

EcsFargateContainerDefinition

A container orchestrated by ECS that uses Fargate resources.

Construct›EcsFargateContainerDefinition

implements

• IEcsContainerDefinition,
• IEcsFargateContainerDefinition,
• IConstruct,
• 1 more

  • IDependable

Source

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

Type last changed

v2.215.0 · 15 Sep 2025

Example

const jobDefn = new batch.EcsJobDefinition(this, 'JobDefn', {
  container: new batch.EcsFargateContainerDefinition(this, 'myFargateContainer', {
    image: ecs.ContainerImage.fromRegistry('public.ecr.aws/amazonlinux/amazonlinux:latest'),
    memory: cdk.Size.mebibytes(2048),
    cpu: 256,
    ephemeralStorageSize: cdk.Size.gibibytes(100),
    fargateCpuArchitecture: ecs.CpuArchitecture.ARM64,
    fargateOperatingSystemFamily: ecs.OperatingSystemFamily.LINUX,
  }),
});

job_defn = batch.EcsJobDefinition(self, "JobDefn",
    container=batch.EcsFargateContainerDefinition(self, "myFargateContainer",
        image=ecs.ContainerImage.from_registry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
        memory=cdk.Size.mebibytes(2048),
        cpu=256,
        ephemeral_storage_size=cdk.Size.gibibytes(100),
        fargate_cpu_architecture=ecs.CpuArchitecture.ARM64,
        fargate_operating_system_family=ecs.OperatingSystemFamily.LINUX
    )
)

EcsJobDefinition jobDefn = EcsJobDefinition.Builder.create(this, "JobDefn")
        .container(EcsFargateContainerDefinition.Builder.create(this, "myFargateContainer")
                .image(ContainerImage.fromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"))
                .memory(Size.mebibytes(2048))
                .cpu(256)
                .ephemeralStorageSize(Size.gibibytes(100))
                .fargateCpuArchitecture(CpuArchitecture.ARM64)
                .fargateOperatingSystemFamily(OperatingSystemFamily.LINUX)
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
var jobDefn = new EcsJobDefinition(this, "JobDefn", new EcsJobDefinitionProps {
    Container = new EcsFargateContainerDefinition(this, "myFargateContainer", new EcsFargateContainerDefinitionProps {
        Image = ContainerImage.FromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
        Memory = Size.Mebibytes(2048),
        Cpu = 256,
        EphemeralStorageSize = Size.Gibibytes(100),
        FargateCpuArchitecture = CpuArchitecture.ARM64,
        FargateOperatingSystemFamily = OperatingSystemFamily.LINUX
    })
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
jobDefn := batch.NewEcsJobDefinition(this, jsii.String("JobDefn"), &EcsJobDefinitionProps{
	Container: batch.NewEcsFargateContainerDefinition(this, jsii.String("myFargateContainer"), &EcsFargateContainerDefinitionProps{
		Image: ecs.ContainerImage_FromRegistry(jsii.String("public.ecr.aws/amazonlinux/amazonlinux:latest")),
		Memory: cdk.Size_Mebibytes(jsii.Number(2048)),
		Cpu: jsii.Number(256),
		EphemeralStorageSize: cdk.Size_Gibibytes(jsii.Number(100)),
		FargateCpuArchitecture: ecs.CpuArchitecture_ARM64(),
		FargateOperatingSystemFamily: ecs.OperatingSystemFamily_LINUX(),
	}),
})

Initializer

new EcsFargateContainerDefinition(scope: Construct, id: string, props: EcsFargateContainerDefinitionProps)

EcsFargateContainerDefinition(scope: Construct, id: str, props: EcsFargateContainerDefinitionProps)

new EcsFargateContainerDefinition(Construct scope, String id, EcsFargateContainerDefinitionProps props)

new EcsFargateContainerDefinition(Construct scope, string id, EcsFargateContainerDefinitionProps props)

NewEcsFargateContainerDefinition(Scope Construct, Id *string, Props EcsFargateContainerDefinitionProps)

Construct Props

assignPublicIp?optionalbooleanassign_public_ip?optionalboolassignPublicIp?optionalBooleanAssignPublicIp?optionalboolAssignPublicIp?optional*bool= false#

Indicates whether the job has a public IP address.

For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet.

command?optionalstring[]command?optionaltyping.List[str]command?optionalList<String>Command?optionalstring[]Command?optional*[]*string#

The command that's passed to the container.

Default: no command

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?optionalbooleanenable_execute_command?optionalboolenableExecuteCommand?optionalBooleanEnableExecuteCommand?optionalboolEnableExecuteCommand?optional*bool#

Determines whether execute command functionality is turned on for this task.

Default: undefined - AWS Batch default is false

notes

If true, execute command functionality is turned on all the containers in the task.

This allows you to use ECS Exec to access containers interactively. When enabled, a job role with required SSM permissions will be created automatically if no job role is provided. If a job role is alreadyprovided, the required permissions will be added to it.

environment?optional{ [key: string]: string }environment?optionaltyping.Mapping[str, str]environment?optionalMap<String, String>Environment?optionalIDictionary<string, string>Environment?optional*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.

ephemeralStorageSize?optionalSizeephemeral_storage_size?optionalSizeephemeralStorageSize?optionalSizeEphemeralStorageSize?optionalSizeEphemeralStorageSize?optionalSize#

The size for ephemeral storage.

Default: 20 GiB

executionRole?optionalIRoleexecution_role?optionalIRoleexecutionRole?optionalIRoleExecutionRole?optionalIRoleExecutionRole?optionalIRole#

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

Default: a Role will be created

fargateCpuArchitecture?optionalCpuArchitecturefargate_cpu_architecture?optionalCpuArchitecturefargateCpuArchitecture?optionalCpuArchitectureFargateCpuArchitecture?optionalCpuArchitectureFargateCpuArchitecture?optionalCpuArchitecture= X86_64#

The vCPU architecture of Fargate Runtime.

fargateOperatingSystemFamily?optionalOperatingSystemFamilyfargate_operating_system_family?optionalOperatingSystemFamilyfargateOperatingSystemFamily?optionalOperatingSystemFamilyFargateOperatingSystemFamily?optionalOperatingSystemFamilyFargateOperatingSystemFamily?optionalOperatingSystemFamily= LINUX#

The operating system for the compute environment.

fargatePlatformVersion?optionalFargatePlatformVersionfargate_platform_version?optionalFargatePlatformVersionfargatePlatformVersion?optionalFargatePlatformVersionFargatePlatformVersion?optionalFargatePlatformVersionFargatePlatformVersion?optionalFargatePlatformVersion= LATEST#

Which version of Fargate to use when running this container.

imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImagerequired#

The image that this container will run.

jobRole?optionalIRolejob_role?optionalIRolejobRole?optionalIRoleJobRole?optionalIRoleJobRole?optionalIRole#

The role that the container can assume.

Default: no job role

linuxParameters?optionalLinuxParameterslinux_parameters?optionalLinuxParameterslinuxParameters?optionalLinuxParametersLinuxParameters?optionalLinuxParametersLinuxParameters?optionalLinuxParameters= none#

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

logging?optionalLogDriverlogging?optionalLogDriverlogging?optionalLogDriverLogging?optionalLogDriverLogging?optionalLogDriver#

The loging configuration for this Job.

Default: the log configuration of the Docker daemon

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.

readonlyRootFilesystem?optionalbooleanreadonly_root_filesystem?optionalboolreadonlyRootFilesystem?optionalBooleanReadonlyRootFilesystem?optionalboolReadonlyRootFilesystem?optional*bool= false#

Gives the container readonly access to its root filesystem.

secrets?optional{ [key: string]: Secret }secrets?optionaltyping.Mapping[str, Secret]secrets?optionalMap<String, Secret>Secrets?optionalIDictionary<string, Secret>Secrets?optional*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?optionalstringuser?optionalstruser?optionalStringUser?optionalstringUser?optional*string#

The user name to use inside the container.

Default: no user

volumes?optionalEcsVolume[]volumes?optionaltyping.List[EcsVolume]volumes?optionalList<EcsVolume>Volumes?optionalEcsVolume[]Volumes?optional*[]EcsVolume#

The volumes to mount to this container.

Default: no volumes

Automatically added to the job definition.

Properties

assignPublicIp?may be undefinedbooleanassign_public_ip?may be undefinedboolassignPublicIp?may be undefinedBooleanAssignPublicIp?may be undefinedboolAssignPublicIp?may be undefined*bool#

Indicates whether the job has a public IP address.

For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet.

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*float64#

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.

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.

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

ephemeralStorageSize?may be undefinedSizeephemeral_storage_size?may be undefinedSizeephemeralStorageSize?may be undefinedSizeEphemeralStorageSize?may be undefinedSizeEphemeralStorageSize?may be undefinedSize#

The size for ephemeral storage.

executionRoleIRoleexecution_roleIRoleexecutionRoleIRoleExecutionRoleIRoleExecutionRoleIRole#

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

fargateCpuArchitecture?may be undefinedCpuArchitecturefargate_cpu_architecture?may be undefinedCpuArchitecturefargateCpuArchitecture?may be undefinedCpuArchitectureFargateCpuArchitecture?may be undefinedCpuArchitectureFargateCpuArchitecture?may be undefinedCpuArchitecture#

The vCPU architecture of Fargate Runtime.

fargateOperatingSystemFamily?may be undefinedOperatingSystemFamilyfargate_operating_system_family?may be undefinedOperatingSystemFamilyfargateOperatingSystemFamily?may be undefinedOperatingSystemFamilyFargateOperatingSystemFamily?may be undefinedOperatingSystemFamilyFargateOperatingSystemFamily?may be undefinedOperatingSystemFamily#

The operating system for the compute environment.

fargatePlatformVersion?may be undefinedFargatePlatformVersionfargate_platform_version?may be undefinedFargatePlatformVersionfargatePlatformVersion?may be undefinedFargatePlatformVersionFargatePlatformVersion?may be undefinedFargatePlatformVersionFargatePlatformVersion?may be undefinedFargatePlatformVersion#

Which version of Fargate to use when running this container.

imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImage#

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.

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

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.

memorySizememorySizememorySizeMemorySizeMemorySize#

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

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

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.

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.

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

The volumes to mount to this container.

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.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

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. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining