An object representing a container instance or task attachment.

An object representing a change in state for a task attachment.

An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

The details of the Auto Scaling group for the capacity provider.

The details of the Auto Scaling group capacity provider to update.

An object representing the networking details for a task or service.

The details for a capacity provider.

The details of a capacity provider strategy. A capacity provider strategy can be set when using the "RunTask" or "CreateCluster" APIs or as the default capacity provider strategy for a cluster with the "CreateCluster" API.

A regional grouping of one or more container instances where you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

The execute command configuration for the cluster.

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.

A Docker container that's part of a task.

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a cluster.

An object representing the health status of the container instance.

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

An object that represents a change in state for a container.

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

Note: The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.

The deployment controller to use for the service. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

An object representing a container instance host device.

This parameter is specified when you're using Docker volumes. Docker volumes are only supported when you're using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

The authorization configuration details for the Amazon EFS file system.

This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

The details of the execute command configuration.

The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.

A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API Reference.

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage.

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its "ContainerDefinition".

Details on a container instance bind mount host volume.

Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

An object representing the result of a container instance health status check.

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page.

A key-value pair object.

Linux-specific options that are applied to the container, such as Linux "KernelCapabilities".

The load balancer configuration to use with a service or task set.

The log configuration for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run.

Details about the managed agent status for the container.

An object representing a change in state for a managed agent.

The managed scaling settings for the Auto Scaling group capacity provider.

Details for a volume mount point that's used in a container definition.

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of "DescribeTasks" API responses.

The network configuration for a task or service.

An object representing the elastic network interface for tasks that use the awsvpc network mode.

An object representing a constraint on task placement. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

The task placement strategy for a task or service. For more information, see Task placement strategies in the Amazon Elastic Container Service Developer Guide.

The devices that are available on the container instance. The only supported device type is a GPU.

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

An object representing the protection status details for a task. You can set the protection status with the "UpdateTaskProtection" API and get the status of tasks with the "GetTaskProtection" API.

The configuration details for the App Mesh proxy.

The repository credentials for private registry authentication.

Describes the resources available for a container instance.

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

Information about the platform for the Amazon ECS service or task.

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

Details on a service within a cluster

Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can use to connect to this service.

The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

The Service Connect service object configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service.

The details for an event that's associated with a service.

The details for the service registry.

The details for the execute command session.

The current account setting for a resource.

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

Details on a task in a cluster.

The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

An object representing a constraint on task placement in the task definition. For more information, see Task placement constraints in the Amazon Elastic Container Service Developer Guide.

The overrides that are associated with a task.

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

The container path, mount options, and size of the tmpfs mount.

The ulimit settings to pass to the container.

The Docker and Amazon ECS container agent version information about a container instance.

A data volume that's used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

Details on a data volume from another container in the same task definition.