Ec2TaskDefinition L2 construct
The details of a task definition run on an EC2 cluster.
Example
ts
// Create a Task Definition for the container to start
const taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');
taskDefinition.addContainer('TheContainer', {
image: ecs.ContainerImage.fromRegistry('example-image'),
memoryLimitMiB: 256,
logging: ecs.LogDrivers.awsLogs({
streamPrefix: 'EventDemo',
mode: ecs.AwsLogDriverMode.NON_BLOCKING,
maxBufferSize: Size.mebibytes(25),
}),
});
python
# Create a Task Definition for the container to start
task_definition = ecs.Ec2TaskDefinition(self, "TaskDef")
task_definition.add_container("TheContainer",
image=ecs.ContainerImage.from_registry("example-image"),
memory_limit_mi_b=256,
logging=ecs.LogDrivers.aws_logs(
stream_prefix="EventDemo",
mode=ecs.AwsLogDriverMode.NON_BLOCKING,
max_buffer_size=Size.mebibytes(25)
)
)
java
// Create a Task Definition for the container to start
Ec2TaskDefinition taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
.image(ContainerImage.fromRegistry("example-image"))
.memoryLimitMiB(256)
.logging(LogDrivers.awsLogs(AwsLogDriverProps.builder()
.streamPrefix("EventDemo")
.mode(AwsLogDriverMode.NON_BLOCKING)
.maxBufferSize(Size.mebibytes(25))
.build()))
.build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
// Create a Task Definition for the container to start
var taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
taskDefinition.AddContainer("TheContainer", new ContainerDefinitionOptions {
Image = ContainerImage.FromRegistry("example-image"),
MemoryLimitMiB = 256,
Logging = LogDrivers.AwsLogs(new AwsLogDriverProps {
StreamPrefix = "EventDemo",
Mode = AwsLogDriverMode.NON_BLOCKING,
MaxBufferSize = Size.Mebibytes(25)
})
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Create a Task Definition for the container to start
taskDefinition := ecs.NewEc2TaskDefinition(this, jsii.String("TaskDef"))
taskDefinition.AddContainer(jsii.String("TheContainer"), &ContainerDefinitionOptions{
Image: ecs.ContainerImage_FromRegistry(jsii.String("example-image")),
MemoryLimitMiB: jsii.Number(256),
Logging: ecs.LogDrivers_AwsLogs(&AwsLogDriverProps{
StreamPrefix: jsii.String("EventDemo"),
Mode: ecs.AwsLogDriverMode_NON_BLOCKING,
MaxBufferSize: awscdk.Size_Mebibytes(jsii.Number(25)),
}),
})
Initializer
ts
new Ec2TaskDefinition(scope: Construct, id: string, props?: Ec2TaskDefinitionProps)
python
Ec2TaskDefinition(scope: Construct, id: str, props: typing.Optional[Ec2TaskDefinitionProps] = None)
java
new Ec2TaskDefinition(Construct scope, String id, Ec2TaskDefinitionProps props)
csharp
new Ec2TaskDefinition(Construct scope, string id, Ec2TaskDefinitionProps? props = null)
go
NewEc2TaskDefinition(Scope Construct, Id *string, Props Ec2TaskDefinitionProps)
Construct Props
enableFaultInjectionbooleanenable_fault_injectionboolenableFaultInjectionBooleanEnableFaultInjectionboolEnableFaultInjection*bool= undefined - ECS default setting …#Enables fault injection and allows for fault injection requests to be accepted from the task's containers.
Fault injection only works with tasks using the {@link NetworkMode.AWS_VPC} or {@link NetworkMode.HOST} network modes.
default
Default: undefined - ECS default setting is false
executionRoleIRoleexecution_roleIRoleexecutionRoleIRoleExecutionRoleIRoleExecutionRoleIRole= An execution role will be automa…#The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf.
The role will be used to retrieve container images from ECR and create CloudWatch log groups.
default
Default: An execution role will be automatically created if you use ECR images in your task definition.
The name of a family that this task definition is registered to.
A family groups multiple versions of a task definition.
inferenceAcceleratorsInferenceAccelerator[]inference_acceleratorstyping.List[InferenceAccelerator]inferenceAcceleratorsList<InferenceAccelerator>InferenceAcceleratorsInferenceAccelerator[]InferenceAccelerators*[]InferenceAccelerator= No inference accelerators.#The inference accelerators to use for the containers in the task.
Not supported in Fargate.
ipcModeIpcModeipc_modeIpcModeipcModeIpcModeIpcModeIpcModeIpcModeIpcMode= IpcMode used by the task is not …#The IPC resource namespace to use for the containers in the task.
Not supported in Fargate and Windows containers.
default
Default: IpcMode used by the task is not specified
networkModeNetworkModenetwork_modeNetworkModenetworkModeNetworkModeNetworkModeNetworkModeNetworkModeNetworkMode= NetworkMode.BRIDGE for EC2 tasks…#The Docker networking mode to use for the containers in the task.
The valid values are NONE, BRIDGE, AWS_VPC, and HOST.
default
Default: NetworkMode.BRIDGE for EC2 tasks, AWS_VPC for Fargate tasks.
pidModePidModepid_modePidModepidModePidModePidModePidModePidModePidMode= PidMode used by the task is not …#The process namespace to use for the containers in the task.
Not supported in Windows containers.
default
Default: PidMode used by the task is not specified
placementConstraintsPlacementConstraint[]placement_constraintstyping.List[PlacementConstraint]placementConstraintsList<PlacementConstraint>PlacementConstraintsPlacementConstraint[]PlacementConstraints*[]PlacementConstraint= No placement constraints.#An array of placement constraint objects to use for the task.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).
proxyConfigurationProxyConfigurationproxy_configurationProxyConfigurationproxyConfigurationProxyConfigurationProxyConfigurationProxyConfigurationProxyConfigurationProxyConfiguration= No proxy configuration.#The configuration details for the App Mesh proxy.
taskRoleIRoletask_roleIRoletaskRoleIRoleTaskRoleIRoleTaskRoleIRole= A task role is automatically cre…#The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
default
Default: A task role is automatically created for you.
volumesVolume[]volumestyping.List[Volume]volumesList<Volume>VolumesVolume[]Volumes*[]Volume= No volumes are passed to the Doc…#The list of volume definitions for the task.
For more information, see Task Definition Parameter Volumes.
default
Default: No volumes are passed to the Docker daemon on a container instance.
Properties
compatibilityCompatibilitycompatibilityCompatibilitycompatibilityCompatibilityCompatibilityCompatibilityCompatibilityCompatibilityrequired#The task launch type compatibility requirement.
defaultContainerContainerDefinitiondefault_containerContainerDefinitiondefaultContainerContainerDefinitionDefaultContainerContainerDefinitionDefaultContainerContainerDefinition#Default container for this task.
Load balancers will send traffic to this container. The first essential container that is added to this task will become the default container.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
ephemeralStorageGiBnumberephemeral_storage_gi_bint | floatephemeralStorageGiBNumberEphemeralStorageGiBdoubleEphemeralStorageGiB*float64#The amount (in GiB) of ephemeral storage to be allocated to the task.
Only supported in Fargate platform version 1.4.0 or later for Linux tasks, and platform version 1.0.0 or later for Windows tasks.
Execution role for this task definition.
The name of a family that this task definition is registered to.
A family groups multiple versions of a task definition.
inferenceAcceleratorsInferenceAccelerator[]inference_acceleratorstyping.List[InferenceAccelerator]inferenceAcceleratorsList<InferenceAccelerator>InferenceAcceleratorsInferenceAccelerator[]InferenceAccelerators*[]InferenceAcceleratorrequired#Public getter method to access list of inference accelerators attached to the instance.
isEc2Compatiblebooleanis_ec2_compatibleboolisEc2CompatibleBooleanIsEc2CompatibleboolIsEc2Compatible*boolrequired#Return true if the task definition can be run on an EC2 cluster.
isExternalCompatiblebooleanis_external_compatibleboolisExternalCompatibleBooleanIsExternalCompatibleboolIsExternalCompatible*boolrequired#Return true if the task definition can be run on a ECS anywhere cluster.
isFargateCompatiblebooleanis_fargate_compatibleboolisFargateCompatibleBooleanIsFargateCompatibleboolIsFargateCompatible*boolrequired#Return true if the task definition can be run on a Fargate cluster.
isManagedInstancesCompatiblebooleanis_managed_instances_compatibleboolisManagedInstancesCompatibleBooleanIsManagedInstancesCompatibleboolIsManagedInstancesCompatible*boolrequired#Return true if the task definition can be run on Managed Instances.
networkModeNetworkModenetwork_modeNetworkModenetworkModeNetworkModeNetworkModeNetworkModeNetworkModeNetworkModerequired#The networking mode to use for the containers in the task.
The process namespace to use for the containers in the task.
notes
Only supported for tasks that are hosted on AWS Fargate if the tasks are using platform version 1.4.0 or later (Linux). Not supported in Windows containers. If pidMode is specified for a Fargate task, then runtimePlatform.operatingSystemFamily must also be specified. For more information, see Task Definition Parameters.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
referencesSecretJsonFieldbooleanreferences_secret_json_fieldboolreferencesSecretJsonFieldBooleanReferencesSecretJsonFieldboolReferencesSecretJsonField*bool#Whether this task definition has at least a container that references a specific JSON field of a secret stored in Secrets Manager.
runtimePlatformRuntimePlatformruntime_platformRuntimePlatformruntimePlatformRuntimePlatformRuntimePlatformRuntimePlatformRuntimePlatformRuntimePlatform#The runtime platform (operating system family and CPU architecture) for the task definition, or `undefined` if none was configured.
Intentionally public: runtimePlatform is already public API as an input prop and on the underlying L1 CfnTaskDefinition, so reading it back from the L2 is deliberate read-parity.
The stack in which this resource is defined.
taskDefinitionArnstringtask_definition_arnstrtaskDefinitionArnStringTaskDefinitionArnstringTaskDefinitionArn*stringrequired#The full Amazon Resource Name (ARN) of the task definition.
taskDefinitionRefTaskDefinitionReferencetask_definition_refTaskDefinitionReferencetaskDefinitionRefTaskDefinitionReferenceTaskDefinitionRefTaskDefinitionReferenceTaskDefinitionRefTaskDefinitionReferencerequired#A reference to this task definition.
Methods
addContainer(id: string, props: ContainerDefinitionOptions): ContainerDefinitiondef add_container(self, id: str, props: ContainerDefinitionOptions) -> ContainerDefinitionpublic ContainerDefinition addContainer(String id, ContainerDefinitionOptions props)public ContainerDefinition AddContainer(string id, ContainerDefinitionOptions props)func AddContainer(Id *string, Props ContainerDefinitionOptions) ContainerDefinition#Tasks running in AWSVPC networking mode requires an additional environment variable for the region to be sourced.
This override adds in the additional environment variable as required
addExtension(extension: ITaskDefinitionExtension): voiddef add_extension(self, extension: ITaskDefinitionExtension) -> Nonepublic void addExtension(ITaskDefinitionExtension extension)public void AddExtension(ITaskDefinitionExtension extension)func AddExtension(Extension ITaskDefinitionExtension)#Adds the specified extension to the task definition.
Extension can be used to apply a packaged modification to a task definition.
addFirelensLogRouter(id: string, props: FirelensLogRouterDefinitionOptions): FirelensLogRouterdef add_firelens_log_router(self, id: str, props: FirelensLogRouterDefinitionOptions) -> FirelensLogRouterpublic FirelensLogRouter addFirelensLogRouter(String id, FirelensLogRouterDefinitionOptions props)public FirelensLogRouter AddFirelensLogRouter(string id, FirelensLogRouterDefinitionOptions props)func AddFirelensLogRouter(Id *string, Props FirelensLogRouterDefinitionOptions) FirelensLogRouter#Adds a firelens log router to the task definition.
addInferenceAccelerator(inferenceAccelerator: InferenceAccelerator): voiddef add_inference_accelerator(self, inference_accelerator: InferenceAccelerator) -> Nonepublic void addInferenceAccelerator(InferenceAccelerator inferenceAccelerator)public void AddInferenceAccelerator(InferenceAccelerator inferenceAccelerator)func AddInferenceAccelerator(InferenceAccelerator InferenceAccelerator)deprecated#ECS TaskDefinition's inferenceAccelerator is EOL since April 2024
addPlacementConstraint(constraint: PlacementConstraint): voiddef add_placement_constraint(self, constraint: PlacementConstraint) -> Nonepublic void addPlacementConstraint(PlacementConstraint constraint)public void AddPlacementConstraint(PlacementConstraint constraint)func AddPlacementConstraint(Constraint PlacementConstraint)#Adds the specified placement constraint to the task definition.
addToExecutionRolePolicy(statement: PolicyStatement): voiddef add_to_execution_role_policy(self, statement: PolicyStatement) -> Nonepublic void addToExecutionRolePolicy(PolicyStatement statement)public void AddToExecutionRolePolicy(PolicyStatement statement)func AddToExecutionRolePolicy(Statement PolicyStatement)#Adds a policy statement to the task execution IAM role.
addToTaskRolePolicy(statement: PolicyStatement): voiddef add_to_task_role_policy(self, statement: PolicyStatement) -> Nonepublic void addToTaskRolePolicy(PolicyStatement statement)public void AddToTaskRolePolicy(PolicyStatement statement)func AddToTaskRolePolicy(Statement PolicyStatement)#Adds a policy statement to the task IAM role.
addVolume(volume: Volume): voiddef add_volume(self, volume: Volume) -> Nonepublic void addVolume(Volume volume)public void AddVolume(Volume volume)func AddVolume(Volume Volume)#Adds a volume to the task definition.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
findContainer(containerName: string): ContainerDefinitiondef find_container(self, container_name: str) -> ContainerDefinitionpublic ContainerDefinition findContainer(String containerName)public ContainerDefinition FindContainer(string containerName)func FindContainer(ContainerName *string) ContainerDefinition#Returns the container that match the provided containerName.
findPortMappingByName(name: string): PortMappingdef find_port_mapping_by_name(self, name: str) -> PortMappingpublic PortMapping findPortMappingByName(String name)public PortMapping FindPortMappingByName(string name)func FindPortMappingByName(Name *string) PortMapping#Determine the existing port mapping for the provided name.
1 parameter · returns
Parameters
namenamenamenameName— : port mapping name.
Returns: PortMapping for the provided name, if it exists.
fromEc2TaskDefinitionArn(scope: Construct, id: string, ec2TaskDefinitionArn: string): IEc2TaskDefinition@staticmethod def from_ec2_task_definition_arn(scope: Construct, id: str, ec2_task_definition_arn: str) -> IEc2TaskDefinitionpublic static IEc2TaskDefinition fromEc2TaskDefinitionArn(Construct scope, String id, String ec2TaskDefinitionArn)public static IEc2TaskDefinition FromEc2TaskDefinitionArn(Construct scope, string id, string ec2TaskDefinitionArn)func FromEc2TaskDefinitionArn(Scope Construct, Id *string, Ec2TaskDefinitionArn *string) IEc2TaskDefinitionstatic#Imports a task definition from the specified task definition ARN.
fromEc2TaskDefinitionAttributes(scope: Construct, id: string, attrs: Ec2TaskDefinitionAttributes): IEc2TaskDefinition@staticmethod def from_ec2_task_definition_attributes(scope: Construct, id: str, attrs: Ec2TaskDefinitionAttributes) -> IEc2TaskDefinitionpublic static IEc2TaskDefinition fromEc2TaskDefinitionAttributes(Construct scope, String id, Ec2TaskDefinitionAttributes attrs)public static IEc2TaskDefinition FromEc2TaskDefinitionAttributes(Construct scope, string id, Ec2TaskDefinitionAttributes attrs)func FromEc2TaskDefinitionAttributes(Scope Construct, Id *string, Attrs Ec2TaskDefinitionAttributes) IEc2TaskDefinitionstatic#Imports an existing Ec2 task definition from its attributes.
fromTaskDefinitionArn(scope: Construct, id: string, taskDefinitionArn: string): ITaskDefinition@staticmethod def from_task_definition_arn(scope: Construct, id: str, task_definition_arn: str) -> ITaskDefinitionpublic static ITaskDefinition fromTaskDefinitionArn(Construct scope, String id, String taskDefinitionArn)public static ITaskDefinition FromTaskDefinitionArn(Construct scope, string id, string taskDefinitionArn)func FromTaskDefinitionArn(Scope Construct, Id *string, TaskDefinitionArn *string) ITaskDefinitionstatic#Imports a task definition from the specified task definition ARN.
The task will have a compatibility of EC2+Fargate.
fromTaskDefinitionAttributes(scope: Construct, id: string, attrs: TaskDefinitionAttributes): ITaskDefinition@staticmethod def from_task_definition_attributes(scope: Construct, id: str, attrs: TaskDefinitionAttributes) -> ITaskDefinitionpublic static ITaskDefinition fromTaskDefinitionAttributes(Construct scope, String id, TaskDefinitionAttributes attrs)public static ITaskDefinition FromTaskDefinitionAttributes(Construct scope, string id, TaskDefinitionAttributes attrs)func FromTaskDefinitionAttributes(Scope Construct, Id *string, Attrs TaskDefinitionAttributes) ITaskDefinitionstatic#Create a task definition from a task definition reference.
grantRun(grantee: IGrantable): Grantdef grant_run(self, grantee: IGrantable) -> Grantpublic Grant grantRun(IGrantable grantee)public Grant GrantRun(IGrantable grantee)func GrantRun(Grantee IGrantable) Grant#Grants permissions to run this task definition.
This will grant the following permissions:
- ecs:RunTask
- iam:PassRole
[disable-awslint:no-grants]
1 parameter
Parameters
granteegranteegranteegranteeGrantee— Principal to grant consume rights to.
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.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
obtainExecutionRole(): IRoledef obtain_execution_role(self, ) -> IRolepublic IRole obtainExecutionRole()public IRole ObtainExecutionRole()func ObtainExecutionRole() IRole#Creates the task execution IAM role if it doesn't already exist.
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.