Ec2TaskDefinitionProps Struct
The properties for a task definition run on an EC2 cluster.
Example
const ec2TaskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef', {
networkMode: ecs.NetworkMode.BRIDGE,
});
const container = ec2TaskDefinition.addContainer("WebContainer", {
// Use an image from DockerHub
image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
memoryLimitMiB: 1024,
// ... other options here ...
});
Properties
enableFaultInjectionoptionalbooleanenable_fault_injectionoptionalboolenableFaultInjectionoptionalBooleanEnableFaultInjectionoptionalboolEnableFaultInjectionoptional*bool#Default: undefined - ECS default setting is false
Fault injection only works with tasks using the {@link NetworkMode.AWS_VPC} or {@link NetworkMode.HOST} network modes.
executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole#Default: An execution role will be automatically created if you use ECR images in your task definition.
The role will be used to retrieve container images from ECR and create CloudWatch log groups.
Default: Automatically generated name.
A family groups multiple versions of a task definition.
inferenceAcceleratorsoptionalInferenceAccelerator[]inference_acceleratorsoptionaltyping.List[InferenceAccelerator]inferenceAcceleratorsoptionalList<InferenceAccelerator>InferenceAcceleratorsoptionalInferenceAccelerator[]InferenceAcceleratorsoptional*[]InferenceAccelerator#Default: No inference accelerators.
Not supported in Fargate.
ipcModeoptionalIpcModeipc_modeoptionalIpcModeipcModeoptionalIpcModeIpcModeoptionalIpcModeIpcModeoptionalIpcMode#Default: IpcMode used by the task is not specified
Not supported in Fargate and Windows containers.
networkModeoptionalNetworkModenetwork_modeoptionalNetworkModenetworkModeoptionalNetworkModeNetworkModeoptionalNetworkModeNetworkModeoptionalNetworkMode#Default: NetworkMode.BRIDGE for EC2 tasks, AWS_VPC for Fargate tasks.
The valid values are NONE, BRIDGE, AWS_VPC, and HOST.
pidModeoptionalPidModepid_modeoptionalPidModepidModeoptionalPidModePidModeoptionalPidModePidModeoptionalPidMode#Default: PidMode used by the task is not specified
Not supported in Windows containers.
placementConstraintsoptionalPlacementConstraint[]placement_constraintsoptionaltyping.List[PlacementConstraint]placementConstraintsoptionalList<PlacementConstraint>PlacementConstraintsoptionalPlacementConstraint[]PlacementConstraintsoptional*[]PlacementConstraint#Default: No placement constraints.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).
proxyConfigurationoptionalProxyConfigurationproxy_configurationoptionalProxyConfigurationproxyConfigurationoptionalProxyConfigurationProxyConfigurationoptionalProxyConfigurationProxyConfigurationoptionalProxyConfiguration#Default: No proxy configuration.
taskRoleoptionalIRoletask_roleoptionalIRoletaskRoleoptionalIRoleTaskRoleoptionalIRoleTaskRoleoptionalIRole#Default: A task role is automatically created for you.
volumesoptionalVolume[]volumesoptionaltyping.List[Volume]volumesoptionalList<Volume>VolumesoptionalVolume[]Volumesoptional*[]Volume#Default: No volumes are passed to the Docker daemon on a container instance.
For more information, see Task Definition Parameter Volumes.