Skip to main content

​
Legend

​
EcsTaskDefinition

AWS ECS task definition — models the RegisterTaskDefinition API input. All string fields are templateable for << module.input.* >> and << deploy.input.* >> expressions.
​
string
required
Task definition family name(templateable)
​
EcsContainerDefinition[]
required
Container definitions — at least one requiredSee: EcsContainerDefinition(minItems:1; templateable)
​
string | null
Task-level CPU units (required for Fargate) Valid values: “256”, “512”, “1024”, “2048”, “4096” etc.(templateable)
​
string | null
Task-level memory in MiB (required for Fargate)(templateable)
​
enum | null
Network mode — “awsvpc” required for FargateAllowed values: awsvpc | bridge | host | none(templateable)
​
enum[FARGATE,EC2][] | null
Launch type compatibility(templateable)
​
string | null
IAM role ARN for task permissions (containers assume this role)(templateable)
​
string | null
IAM role ARN for ECS agent to pull images and write logs(templateable)
​
EcsRuntimePlatform
Runtime platform (Fargate only)See: EcsRuntimePlatform(templateable)
​
EcsEphemeralStorage
Ephemeral storage (Fargate only, >20 GiB)See: EcsEphemeralStorage(templateable)
​
EcsVolume[] | null
Volumes available to containersSee: EcsVolume(templateable)
​
EcsTag[] | null
AWS resource tagsSee: EcsTag(templateable)
​
enum | null
IPC mode for containers (EC2 only)Allowed values: host | task | none(templateable)
​
enum | null
PID mode for containers (EC2 only)Allowed values: host | task(templateable)
​
EcsProxyConfiguration
App Mesh proxy configurationSee: EcsProxyConfiguration(templateable)
​
EcsInferenceAccelerator[] | null
Inference accelerators (EC2 only)See: EcsInferenceAccelerator(templateable)

​
EcsInferenceAccelerator

Inference accelerator for ML workloads
​
string
required
Accelerator name(templateable)
​
string
required
Accelerator type(templateable)

​
EcsProxyConfiguration

App Mesh proxy configuration
​
enum | null
Proxy typeAllowed values: APPMESH(templateable)
​
string
required
Container name for the proxy(templateable)
​
EcsProxyConfigurationProperty[] | null
Proxy configuration propertiesSee: EcsProxyConfigurationProperty(templateable)

​
EcsRuntimePlatform

ECS runtime platform configuration
​
enum | null
CPU architecture — X86_64 or ARM64Allowed values: X86_64 | ARM64(templateable)
​
enum | null
Operating system familyAllowed values: LINUX | WINDOWS_SERVER_2019_FULL | WINDOWS_SERVER_2019_CORE | WINDOWS_SERVER_2022_FULL | WINDOWS_SERVER_2022_CORE(templateable)

​
EcsVolume

ECS volume — host path or Docker volume
​
string
required
Volume name — referenced by container mount points(templateable)
​
string | null
Host path for bind mounts (EC2 only)(templateable)
​
EcsEfsVolumeConfiguration
EFS volume configurationSee: EcsEfsVolumeConfiguration(templateable)

​
EcsTaskManagedEBSVolumeConfiguration

AWS-managed Fargate ephemeral EBS volume configuration.https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html
​
string
required
IAM role ARN AWS uses to provision the EBS volume on the customer’s behalf. Required.(templateable)
​
string | null
EBS volume type (gp3, gp2, io2, io1, sc1, st1, standard).(templateable)
​
integer | null
Volume size (GiB). Range depends on volume_type.(format:int32; templateable)
​
string | null
Snapshot id to restore from.(templateable)
​
integer | null
Provisioned IOPS — required for io1/io2, optional for gp3.(format:int32; templateable)
​
integer | null
Provisioned throughput (MiB/s) — gp3 only.(format:int32; templateable)
​
string | null
Filesystem type to format the volume with (ext3, ext4, xfs, ntfs). Defaults per OS family.(templateable)
​
string | null
KMS key id (alias or ARN) for at-rest encryption.(templateable)
​
boolean | null
Whether the volume is encrypted at rest.(templateable)
​
EcsEBSTagSpecification[] | null
Tag specifications applied to the EBS volume.See: EcsEBSTagSpecification(templateable)
​
EcsTaskManagedEBSVolumeTerminationPolicy
Termination policy — controls whether the volume is deleted when the task stops.See: EcsTaskManagedEBSVolumeTerminationPolicy(templateable)
​
integer | null
Initialization rate (MiB/s) for snapshot-restored volumes — controls how fast blocks are pre-warmed.(format:int32; templateable)

​
EcsProxyConfigurationProperty

Proxy configuration key-value property
​
string
required
Property name(templateable)
​
string
required
Property value(templateable)

​
EcsEfsVolumeConfiguration

EFS volume configuration for ECS tasks
​
string
required
EFS file system ID(templateable)
​
string | null
Root directory on the EFS file system(templateable)
​
enum | null
Whether to enable IAM authorizationAllowed values: ENABLED | DISABLED(templateable)
​
integer | null
Port for transit encryption (default 2049)(format:int32; templateable)
​
EcsEfsAuthorizationConfig
EFS access point IDSee: EcsEfsAuthorizationConfig(templateable)

​
EcsEBSTagSpecification

Tag specification for an ECS-managed EBS volume.https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_EBSTagSpecification.html
​
enum
required
Resource type the tags apply to. Currently only volume is supported.Allowed values: volume(templateable)
​
enum | null
Where the tags come from — explicit list, propagated from the task definition, or none.Allowed values: TASK_DEFINITION | SERVICE | NONE(templateable)
​
EcsTag[] | null
Explicit tags.See: EcsTag(templateable)

​
EcsTaskManagedEBSVolumeTerminationPolicy

Termination policy for an ECS-managed EBS volume.https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeTerminationPolicy.html
​
boolean
required
Whether to delete the volume when the task stops.(templateable)

​
EcsEfsAuthorizationConfig

EFS authorization config
​
string | null
EFS access point ID(templateable)
​
enum | null
Whether to use the task execution role for EFSAllowed values: ENABLED | DISABLED(templateable)