Package software.amazon.awscdk.services.batch

Interface EcsJobDefinitionProps

All Superinterfaces:

JobDefinitionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EcsJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:51:52.638Z")
@Stability(Stable)
public interface EcsJobDefinitionProps
extends software.amazon.jsii.JsiiSerializable, JobDefinitionProps

Props for EcsJobDefinition.

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

Method Summary

Modifier and Type	Method	Description
static EcsJobDefinitionProps.Builder	builder()
IEcsContainerDefinition	getContainer()	The container that this job will run.
default Boolean	getPropagateTags()	Whether to propagate tags from the JobDefinition to the ECS task that Batch spawns.

Methods inherited from interface software.amazon.awscdk.services.batch.JobDefinitionProps

getJobDefinitionName, getParameters, getRetryAttempts, getRetryStrategies, getSchedulingPriority, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainer

@Stability(Stable)
@NotNull
IEcsContainerDefinition getContainer()

The container that this job will run.

getPropagateTags

@Stability(Stable)
@Nullable
default Boolean getPropagateTags()

Whether to propagate tags from the JobDefinition to the ECS task that Batch spawns.

Default: false

builder

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

Returns:

a EcsJobDefinitionProps.Builder of EcsJobDefinitionProps