Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the FARGATE and FARGATE_SPOT capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate.
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter):
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
" }, "DeleteAttributes": { "name": "DeleteAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteAttributesRequest" }, "output": { "shape": "DeleteAttributesResponse" }, "errors": [ { "shape": "ClusterNotFoundException" }, { "shape": "TargetNotFoundException" }, { "shape": "InvalidParameterException" } ], "documentation": "Deletes one or more custom attributes from an Amazon ECS resource.
" }, "DeleteCluster": { "name": "DeleteCluster", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteClusterRequest" }, "output": { "shape": "DeleteClusterResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" }, { "shape": "ClusterNotFoundException" }, { "shape": "ClusterContainsContainerInstancesException" }, { "shape": "ClusterContainsServicesException" }, { "shape": "ClusterContainsTasksException" }, { "shape": "UpdateInProgressException" } ], "documentation": "Deletes the specified cluster. The cluster will transition to the INACTIVE state. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
" }, "DeleteService": { "name": "DeleteService", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteServiceRequest" }, "output": { "shape": "DeleteServiceResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" }, { "shape": "ClusterNotFoundException" }, { "shape": "ServiceNotFoundException" } ], "documentation": "Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.
Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.
Describes one or more of your capacity providers.
" }, "DescribeClusters": { "name": "DescribeClusters", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeClustersRequest" }, "output": { "shape": "DescribeClustersResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" } ], "documentation": "Describes one or more of your clusters.
" }, "DescribeContainerInstances": { "name": "DescribeContainerInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeContainerInstancesRequest" }, "output": { "shape": "DescribeContainerInstancesResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" }, { "shape": "ClusterNotFoundException" } ], "documentation": "Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
" }, "DescribeServices": { "name": "DescribeServices", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeServicesRequest" }, "output": { "shape": "DescribeServicesResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" }, { "shape": "ClusterNotFoundException" } ], "documentation": "Describes the specified services running in your cluster.
" }, "DescribeTaskDefinition": { "name": "DescribeTaskDefinition", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTaskDefinitionRequest" }, "output": { "shape": "DescribeTaskDefinitionResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" } ], "documentation": "Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.
You can only describe INACTIVE task definitions while an active task or service references them.
Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Describes a specified task or tasks.
" }, "DiscoverPollEndpoint": { "name": "DiscoverPollEndpoint", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DiscoverPollEndpointRequest" }, "output": { "shape": "DiscoverPollEndpointResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" } ], "documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
" }, "ListAccountSettings": { "name": "ListAccountSettings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListAccountSettingsRequest" }, "output": { "shape": "ListAccountSettingsResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" } ], "documentation": "Lists the account settings for a specified principal.
" }, "ListAttributes": { "name": "ListAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListAttributesRequest" }, "output": { "shape": "ListAttributesResponse" }, "errors": [ { "shape": "ClusterNotFoundException" }, { "shape": "InvalidParameterException" } ], "documentation": "Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
Returns a list of existing clusters.
" }, "ListContainerInstances": { "name": "ListContainerInstances", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListContainerInstancesRequest" }, "output": { "shape": "ListContainerInstancesResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" }, { "shape": "ClusterNotFoundException" } ], "documentation": "Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Lists the services that are running in a specified cluster.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "ClusterNotFoundException" }, { "shape": "InvalidParameterException" } ], "documentation": "List the tags for an Amazon ECS resource.
" }, "ListTaskDefinitionFamilies": { "name": "ListTaskDefinitionFamilies", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTaskDefinitionFamiliesRequest" }, "output": { "shape": "ListTaskDefinitionFamiliesResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" } ], "documentation": "Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).
You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
" }, "PutAccountSetting": { "name": "PutAccountSetting", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutAccountSettingRequest" }, "output": { "shape": "PutAccountSettingResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" } ], "documentation": "Modifies an account setting. Account settings are set on a per-Region basis.
If you change the account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.
" }, "PutAttributes": { "name": "PutAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutAttributesRequest" }, "output": { "shape": "PutAttributesResponse" }, "errors": [ { "shape": "ClusterNotFoundException" }, { "shape": "TargetNotFoundException" }, { "shape": "AttributeLimitExceededException" }, { "shape": "InvalidParameterException" } ], "documentation": "Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
" }, "PutClusterCapacityProviders": { "name": "PutClusterCapacityProviders", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutClusterCapacityProvidersRequest" }, "output": { "shape": "PutClusterCapacityProvidersResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" }, { "shape": "ClusterNotFoundException" }, { "shape": "ResourceInUseException" }, { "shape": "UpdateInProgressException" } ], "documentation": "Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. It is recommended to define a default capacity provider strategy for your cluster, however you may specify an empty array ([]) to bypass defining a default strategy.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
" }, "RegisterTaskDefinition": { "name": "RegisterTaskDefinition", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterTaskDefinitionRequest" }, "output": { "shape": "RegisterTaskDefinitionResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" } ], "documentation": "Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
" }, "StopTask": { "name": "StopTask", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopTaskRequest" }, "output": { "shape": "StopTaskResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" }, { "shape": "ClusterNotFoundException" } ], "documentation": "Stops a running task. Any tags associated with the task will be deleted.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that an attachment changed states.
" }, "SubmitContainerStateChange": { "name": "SubmitContainerStateChange", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SubmitContainerStateChangeRequest" }, "output": { "shape": "SubmitContainerStateChangeResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "AccessDeniedException" } ], "documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
" }, "SubmitTaskStateChange": { "name": "SubmitTaskStateChange", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SubmitTaskStateChangeRequest" }, "output": { "shape": "SubmitTaskStateChangeResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidParameterException" } ], "documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "ClusterNotFoundException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterException" } ], "documentation": "Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
Deletes specified tags from a resource.
" }, "UpdateClusterSettings": { "name": "UpdateClusterSettings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateClusterSettingsRequest" }, "output": { "shape": "UpdateClusterSettingsResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "ClusterNotFoundException" }, { "shape": "InvalidParameterException" } ], "documentation": "Modifies the settings to use for a cluster.
" }, "UpdateContainerAgent": { "name": "UpdateContainerAgent", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateContainerAgentRequest" }, "output": { "shape": "UpdateContainerAgentResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "ClientException" }, { "shape": "InvalidParameterException" }, { "shape": "ClusterNotFoundException" }, { "shape": "UpdateInProgressException" }, { "shape": "NoUpdateAvailableException" }, { "shape": "MissingVersionException" } ], "documentation": "Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide.
Modifies the status of an Amazon ECS container instance.
Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
A container instance cannot be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms apply to your participation in this preview.
Modifies the parameters of a service.
For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
The unique identifier for the attachment.
" }, "type": { "shape": "String", "documentation": "The type of the attachment, such as ElasticNetworkInterface.
The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, and DELETED.
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
" } }, "documentation": "An object representing a container instance or task attachment.
" }, "AttachmentDetails": { "type": "list", "member": { "shape": "KeyValuePair" } }, "AttachmentStateChange": { "type": "structure", "required": [ "attachmentArn", "status" ], "members": { "attachmentArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the attachment.
" }, "status": { "shape": "String", "documentation": "The status of the attachment.
" } }, "documentation": "An object representing a change in state for a task attachment.
" }, "AttachmentStateChanges": { "type": "list", "member": { "shape": "AttachmentStateChange" } }, "Attachments": { "type": "list", "member": { "shape": "Attachment" } }, "Attribute": { "type": "structure", "required": [ "name" ], "members": { "name": { "shape": "String", "documentation": "The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
" }, "value": { "shape": "String", "documentation": "The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
" }, "targetType": { "shape": "TargetType", "documentation": "The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
" }, "targetId": { "shape": "String", "documentation": "The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
" } }, "documentation": "An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you 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.
" }, "Attributes": { "type": "list", "member": { "shape": "Attribute" } }, "AutoScalingGroupProvider": { "type": "structure", "required": [ "autoScalingGroupArn" ], "members": { "autoScalingGroupArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
" }, "managedScaling": { "shape": "ManagedScaling", "documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" }, "managedTerminationProtection": { "shape": "ManagedTerminationProtection", "documentation": "The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
" } }, "documentation": "The details of the Auto Scaling group for the capacity provider.
" }, "AwsVpcConfiguration": { "type": "structure", "required": [ "subnets" ], "members": { "subnets": { "shape": "StringList", "documentation": "The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.
All specified subnets must be from the same VPC.
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.
All specified security groups must be from the same VPC.
Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
An object representing the networking details for a task or service.
" }, "Boolean": { "type": "boolean" }, "BoxedBoolean": { "type": "boolean", "box": true }, "BoxedInteger": { "type": "integer", "box": true }, "CapacityProvider": { "type": "structure", "members": { "capacityProviderArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) that identifies the capacity provider.
" }, "name": { "shape": "String", "documentation": "The name of the capacity provider.
" }, "status": { "shape": "CapacityProviderStatus", "documentation": "The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster.
The Auto Scaling group settings for the capacity provider.
" }, "tags": { "shape": "Tags", "documentation": "The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The details of a capacity provider.
" }, "CapacityProviderField": { "type": "string", "enum": [ "TAGS" ] }, "CapacityProviderFieldList": { "type": "list", "member": { "shape": "CapacityProviderField" } }, "CapacityProviderStatus": { "type": "string", "enum": [ "ACTIVE" ] }, "CapacityProviderStrategy": { "type": "list", "member": { "shape": "CapacityProviderStrategyItem" } }, "CapacityProviderStrategyItem": { "type": "structure", "required": [ "capacityProvider" ], "members": { "capacityProvider": { "shape": "String", "documentation": "The short name of the capacity provider.
" }, "weight": { "shape": "CapacityProviderStrategyItemWeight", "documentation": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
" } }, "documentation": "The details of a capacity provider strategy.
" }, "CapacityProviderStrategyItemBase": { "type": "integer", "max": 100000, "min": 0 }, "CapacityProviderStrategyItemWeight": { "type": "integer", "max": 1000, "min": 0 }, "CapacityProviders": { "type": "list", "member": { "shape": "CapacityProvider" } }, "Cluster": { "type": "structure", "members": { "clusterArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.
A user-generated string that you use to identify your cluster.
" }, "status": { "shape": "String", "documentation": "The status of the cluster. The following are the possible states that will be returned.
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.
The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.
Additional information about your clusters that are separated by launch type, including:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
" }, "capacityProviders": { "shape": "StringList", "documentation": "The capacity providers associated with the cluster.
" }, "defaultCapacityProviderStrategy": { "shape": "CapacityProviderStrategy", "documentation": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
" }, "attachments": { "shape": "Attachments", "documentation": "The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
" }, "attachmentsStatus": { "shape": "String", "documentation": "The status of the capacity providers associated with the cluster. The following are the states that will be returned:
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
The capacity providers have successfully updated.
The capacity provider updates failed.
A regional grouping of one or more container instances on which 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.
" }, "ClusterField": { "type": "string", "enum": [ "ATTACHMENTS", "SETTINGS", "STATISTICS", "TAGS" ] }, "ClusterFieldList": { "type": "list", "member": { "shape": "ClusterField" } }, "ClusterSetting": { "type": "structure", "members": { "name": { "shape": "ClusterSettingName", "documentation": "The name of the cluster setting. The only supported value is containerInsights.
The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
" }, "ClusterSettingName": { "type": "string", "enum": [ "containerInsights" ] }, "ClusterSettings": { "type": "list", "member": { "shape": "ClusterSetting" } }, "Clusters": { "type": "list", "member": { "shape": "Cluster" } }, "Compatibility": { "type": "string", "enum": [ "EC2", "FARGATE" ] }, "CompatibilityList": { "type": "list", "member": { "shape": "Compatibility" } }, "Connectivity": { "type": "string", "enum": [ "CONNECTED", "DISCONNECTED" ] }, "Container": { "type": "structure", "members": { "containerArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the container.
" }, "taskArn": { "shape": "String", "documentation": "The ARN of the task.
" }, "name": { "shape": "String", "documentation": "The name of the container.
" }, "image": { "shape": "String", "documentation": "The image used for the container.
" }, "imageDigest": { "shape": "String", "documentation": "The container image manifest digest.
The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.
The ID of the Docker container.
" }, "lastStatus": { "shape": "String", "documentation": "The last known status of the container.
" }, "exitCode": { "shape": "BoxedInteger", "documentation": "The exit code returned from the container.
" }, "reason": { "shape": "String", "documentation": "A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
" }, "networkBindings": { "shape": "NetworkBindings", "documentation": "The network bindings associated with the container.
" }, "networkInterfaces": { "shape": "NetworkInterfaces", "documentation": "The network interfaces associated with the container.
" }, "healthStatus": { "shape": "HealthStatus", "documentation": "The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN.
The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.
The hard limit (in MiB) of memory set for the container.
" }, "memoryReservation": { "shape": "String", "documentation": "The soft limit (in MiB) of memory set for the container.
" }, "gpuIds": { "shape": "GpuIds", "documentation": "The IDs of each GPU assigned to the container.
" } }, "documentation": "A Docker container that is part of a task.
" }, "ContainerCondition": { "type": "string", "enum": [ "START", "COMPLETE", "SUCCESS", "HEALTHY" ] }, "ContainerDefinition": { "type": "structure", "members": { "name": { "shape": "String", "documentation": "The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
The private repository authentication credentials to use.
" }, "cpu": { "shape": "Integer", "documentation": "The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.
" }, "memory": { "shape": "BoxedInteger", "documentation": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
" }, "memoryReservation": { "shape": "BoxedInteger", "documentation": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
" }, "links": { "shape": "StringList", "documentation": "The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.
If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
" }, "entryPoint": { "shape": "StringList", "documentation": "Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.
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 on the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.
This field is not valid for containers in tasks using the Fargate launch type.
" }, "mountPoints": { "shape": "MountPointList", "documentation": "The mount points for data volumes in your container.
This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
" }, "dependsOn": { "shape": "ContainerDependencies", "documentation": "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.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.
Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state.
For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later. If this parameter is not specified, the default value of 3 minutes is used.
For tasks using the EC2 launch type, if the startTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_START_TIMEOUT is used by default. If neither the startTimeout parameter or the ECS_CONTAINER_START_TIMEOUT agent configuration variable are set, then the default values of 3 minutes for Linux containers and 8 minutes on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks using the EC2 launch type, if the stopTimeout parameter is not specified, the value set for the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.
The hostname parameter is not supported if you are using the awsvpc network mode.
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
You can use the following formats. If specifying a UID or GID, you must specify it as a positive integer.
user
user:group
uid
uid:gid
user:gid
uid:group
This parameter is not supported for Windows containers.
The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.
This parameter is not supported for Windows containers.
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
This parameter is not supported for Windows containers.
A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.
This parameter is not supported for Windows containers.
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.
This parameter is not supported for Windows containers.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.
When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.
A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers.
The log configuration specification 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. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The container health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.
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.
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
" }, "firelensConfiguration": { "shape": "FirelensConfiguration", "documentation": "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.
" } }, "documentation": "Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
" }, "ContainerDefinitions": { "type": "list", "member": { "shape": "ContainerDefinition" } }, "ContainerDependencies": { "type": "list", "member": { "shape": "ContainerDependency" } }, "ContainerDependency": { "type": "structure", "required": [ "containerName", "condition" ], "members": { "containerName": { "shape": "String", "documentation": "The name of a container.
" }, "condition": { "shape": "ContainerCondition", "documentation": "The dependency condition of the container. The following are the available conditions and their behavior:
START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit.
SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status.
HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
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.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The EC2 instance ID of the container instance.
" }, "capacityProviderName": { "shape": "String", "documentation": "The capacity provider associated with the container instance.
" }, "version": { "shape": "Long", "documentation": "The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
" }, "remainingResources": { "shape": "Resources", "documentation": "For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
" }, "status": { "shape": "String", "documentation": "The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.
The reason that the container instance reached its current status.
" }, "agentConnected": { "shape": "Boolean", "documentation": "This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept placement requests.
The number of tasks on the container instance that are in the RUNNING status.
The number of tasks on the container instance that are in the PENDING status.
The status of the most recent agent update. If an update has never been requested, this value is NULL.
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
" }, "registeredAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the container instance was registered.
" }, "attachments": { "shape": "Attachments", "documentation": "The resources attached to a container instance, such as elastic network interfaces.
" }, "tags": { "shape": "Tags", "documentation": "The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
" }, "ContainerInstanceField": { "type": "string", "enum": [ "TAGS" ] }, "ContainerInstanceFieldList": { "type": "list", "member": { "shape": "ContainerInstanceField" } }, "ContainerInstanceStatus": { "type": "string", "enum": [ "ACTIVE", "DRAINING", "REGISTERING", "DEREGISTERING", "REGISTRATION_FAILED" ] }, "ContainerInstances": { "type": "list", "member": { "shape": "ContainerInstance" } }, "ContainerOverride": { "type": "structure", "members": { "name": { "shape": "String", "documentation": "The name of the container that receives the override. This parameter is required if any override is specified.
" }, "command": { "shape": "StringList", "documentation": "The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
" }, "environment": { "shape": "EnvironmentVariables", "documentation": "The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
" }, "environmentFiles": { "shape": "EnvironmentFiles", "documentation": "A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
" }, "cpu": { "shape": "BoxedInteger", "documentation": "The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
" }, "memoryReservation": { "shape": "BoxedInteger", "documentation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
" }, "resourceRequirements": { "shape": "ResourceRequirements", "documentation": "The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
" } }, "documentation": "The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {\"containerOverrides\": [ ] }. If a non-empty container override is specified, the name parameter must be included.
The name of the container.
" }, "imageDigest": { "shape": "String", "documentation": "The container image SHA 256 digest.
" }, "runtimeId": { "shape": "String", "documentation": "The ID of the Docker container.
" }, "exitCode": { "shape": "BoxedInteger", "documentation": "The exit code for the container, if the state change is a result of the container exiting.
" }, "networkBindings": { "shape": "NetworkBindings", "documentation": "Any network bindings associated with the container.
" }, "reason": { "shape": "String", "documentation": "The reason for the state change.
" }, "status": { "shape": "String", "documentation": "The status of the container.
" } }, "documentation": "An object representing a change in state for a container.
" }, "ContainerStateChanges": { "type": "list", "member": { "shape": "ContainerStateChange" } }, "Containers": { "type": "list", "member": { "shape": "Container" } }, "CreateCapacityProviderRequest": { "type": "structure", "required": [ "name", "autoScalingGroupProvider" ], "members": { "name": { "shape": "String", "documentation": "The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with \"aws\", \"ecs\", or \"fargate\".
The details of the Auto Scaling group for the capacity provider.
" }, "tags": { "shape": "Tags", "documentation": "The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The full description of the new capacity provider.
" } } }, "CreateClusterRequest": { "type": "structure", "members": { "clusterName": { "shape": "String", "documentation": "The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The short name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "defaultCapacityProviderStrategy": { "shape": "CapacityProviderStrategy", "documentation": "The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
" } } }, "CreateClusterResponse": { "type": "structure", "members": { "cluster": { "shape": "Cluster", "documentation": "The full description of your new cluster.
" } } }, "CreateServiceRequest": { "type": "structure", "required": [ "serviceName" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
" }, "serviceName": { "shape": "String", "documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
" }, "taskDefinition": { "shape": "String", "documentation": "The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.
A task definition must be specified if the service is using the ECS deployment controller.
A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.
After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
The number of instantiations of the specified task definition to place and keep running on your cluster.
This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
" }, "launchType": { "shape": "LaunchType", "documentation": "The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
The capacity provider strategy to use for the service.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "platformVersion": { "shape": "String", "documentation": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
" }, "placementConstraints": { "shape": "PlacementConstraints", "documentation": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
" }, "placementStrategy": { "shape": "PlacementStrategies", "documentation": "The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
" }, "networkConfiguration": { "shape": "NetworkConfiguration", "documentation": "The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" }, "schedulingStrategy": { "shape": "SchedulingStrategy", "documentation": "The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
The deployment controller to use for the service.
" }, "tags": { "shape": "Tags", "documentation": "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" }, "propagateTags": { "shape": "PropagateTags", "documentation": "Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
" } } }, "CreateServiceResponse": { "type": "structure", "members": { "service": { "shape": "Service", "documentation": "The full description of your service following the create call.
If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.
If the service is using the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
" }, "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
" }, "externalId": { "shape": "String", "documentation": "An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
The task definition for the tasks in the task set to use.
" }, "networkConfiguration": { "shape": "NetworkConfiguration" }, "loadBalancers": { "shape": "LoadBalancers", "documentation": "A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
" }, "serviceRegistries": { "shape": "ServiceRegistries", "documentation": "The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
" }, "launchType": { "shape": "LaunchType", "documentation": "The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "platformVersion": { "shape": "String", "documentation": "The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
" }, "tags": { "shape": "Tags", "documentation": "The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The resource name for which to disable the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
" } } }, "DeleteAccountSettingResponse": { "type": "structure", "members": { "setting": { "shape": "Setting", "documentation": "The account setting for the specified principal ARN.
" } } }, "DeleteAttributesRequest": { "type": "structure", "required": [ "attributes" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
" }, "attributes": { "shape": "Attributes", "documentation": "The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.
" } } }, "DeleteAttributesResponse": { "type": "structure", "members": { "attributes": { "shape": "Attributes", "documentation": "A list of attribute objects that were successfully deleted from your resource.
" } } }, "DeleteClusterRequest": { "type": "structure", "required": [ "cluster" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to delete.
" } } }, "DeleteClusterResponse": { "type": "structure", "members": { "cluster": { "shape": "Cluster", "documentation": "The full description of the deleted cluster.
" } } }, "DeleteServiceRequest": { "type": "structure", "required": [ "service" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
" }, "service": { "shape": "String", "documentation": "The name of the service to delete.
" }, "force": { "shape": "BoxedBoolean", "documentation": "If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.
The full description of the deleted service.
" } } }, "DeleteTaskSetRequest": { "type": "structure", "required": [ "cluster", "service", "taskSet" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete.
" }, "service": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.
" }, "taskSet": { "shape": "String", "documentation": "The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
" }, "force": { "shape": "BoxedBoolean", "documentation": "If true, this allows you to delete a task set even if it hasn't been scaled down to zero.
The ID of the deployment.
" }, "status": { "shape": "String", "documentation": "The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.
A deployment that has been completely replaced.
The most recent task definition that was specified for the tasks in the service to use.
" }, "desiredCount": { "shape": "Integer", "documentation": "The most recent desired count of tasks that was specified for the service to deploy or maintain.
" }, "pendingCount": { "shape": "Integer", "documentation": "The number of tasks in the deployment that are in the PENDING status.
The number of tasks in the deployment that are in the RUNNING status.
The Unix timestamp for when the service deployment was created.
" }, "updatedAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the service deployment was last updated.
" }, "capacityProviderStrategy": { "shape": "CapacityProviderStrategy", "documentation": "The capacity provider strategy that the deployment is using.
" }, "launchType": { "shape": "LaunchType", "documentation": "The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" }, "platformVersion": { "shape": "String", "documentation": "The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.
If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
" }, "DeploymentController": { "type": "structure", "required": [ "type" ], "members": { "type": { "shape": "DeploymentControllerType", "documentation": "The deployment controller type to use.
There are three deployment controller types available:
The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.
The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
" }, "DeploymentControllerType": { "type": "string", "enum": [ "ECS", "CODE_DEPLOY", "EXTERNAL" ] }, "Deployments": { "type": "list", "member": { "shape": "Deployment" } }, "DeregisterContainerInstanceRequest": { "type": "structure", "required": [ "containerInstance" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
" }, "containerInstance": { "shape": "String", "documentation": "The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
" } } }, "DeregisterContainerInstanceResponse": { "type": "structure", "members": { "containerInstance": { "shape": "ContainerInstance", "documentation": "The container instance that was deregistered.
" } } }, "DeregisterTaskDefinitionRequest": { "type": "structure", "required": [ "taskDefinition" ], "members": { "taskDefinition": { "shape": "String", "documentation": "The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.
The full description of the deregistered task.
" } } }, "DescribeCapacityProvidersRequest": { "type": "structure", "members": { "capacityProviders": { "shape": "StringList", "documentation": "The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.
Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.
The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The list of capacity providers.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" }, "nextToken": { "shape": "String", "documentation": "The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
" }, "include": { "shape": "ClusterFieldList", "documentation": "Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.
If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.
If SETTINGS is specified, the settings for the cluster are included.
If STATISTICS is specified, the following additional information, separated by launch type, is included:
runningEC2TasksCount
runningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
If TAGS is specified, the metadata tags associated with the cluster are included.
The list of clusters.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" } } }, "DescribeContainerInstancesRequest": { "type": "structure", "required": [ "containerInstances" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
" }, "containerInstances": { "shape": "StringList", "documentation": "A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
" }, "include": { "shape": "ContainerInstanceFieldList", "documentation": "Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The list of container instances.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" } } }, "DescribeServicesRequest": { "type": "structure", "required": [ "services" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.
" }, "services": { "shape": "StringList", "documentation": "A list of services to describe. You may specify up to 10 services to describe in a single operation.
" }, "include": { "shape": "ServiceFieldList", "documentation": "Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The list of services described.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" } } }, "DescribeTaskDefinitionRequest": { "type": "structure", "required": [ "taskDefinition" ], "members": { "taskDefinition": { "shape": "String", "documentation": "The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.
Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The full task definition description.
" }, "tags": { "shape": "Tags", "documentation": "The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
" }, "service": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
" }, "taskSets": { "shape": "StringList", "documentation": "The ID or full Amazon Resource Name (ARN) of task sets to describe.
" }, "include": { "shape": "TaskSetFieldList", "documentation": "Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The list of task sets described.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" } } }, "DescribeTasksRequest": { "type": "structure", "required": [ "tasks" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.
" }, "tasks": { "shape": "StringList", "documentation": "A list of up to 100 task IDs or full ARN entries.
" }, "include": { "shape": "TaskFieldList", "documentation": "Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The list of tasks.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" } } }, "DesiredStatus": { "type": "string", "enum": [ "RUNNING", "PENDING", "STOPPED" ] }, "Device": { "type": "structure", "required": [ "hostPath" ], "members": { "hostPath": { "shape": "String", "documentation": "The path for the device on the host container instance.
" }, "containerPath": { "shape": "String", "documentation": "The path inside the container at which to expose the host device.
" }, "permissions": { "shape": "DeviceCgroupPermissions", "documentation": "The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
An object representing a container instance host device.
" }, "DeviceCgroupPermission": { "type": "string", "enum": [ "read", "write", "mknod" ] }, "DeviceCgroupPermissions": { "type": "list", "member": { "shape": "DeviceCgroupPermission" } }, "DevicesList": { "type": "list", "member": { "shape": "Device" } }, "DiscoverPollEndpointRequest": { "type": "structure", "members": { "containerInstance": { "shape": "String", "documentation": "The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.
" } } }, "DiscoverPollEndpointResponse": { "type": "structure", "members": { "endpoint": { "shape": "String", "documentation": "The endpoint for the Amazon ECS agent to poll.
" }, "telemetryEndpoint": { "shape": "String", "documentation": "The telemetry endpoint for the Amazon ECS agent.
" } } }, "DockerLabelsMap": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "String" } }, "DockerVolumeConfiguration": { "type": "structure", "members": { "scope": { "shape": "Scope", "documentation": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
If this value is true, the Docker volume is created if it does not already exist.
This field is only used if the scope is shared.
The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.
A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.
Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.
The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration will be relative to the directory set for the access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.
The authorization configuration details for the Amazon EFS file system.
" }, "EFSAuthorizationConfigIAM": { "type": "string", "enum": [ "ENABLED", "DISABLED" ] }, "EFSTransitEncryption": { "type": "string", "enum": [ "ENABLED", "DISABLED" ] }, "EFSVolumeConfiguration": { "type": "structure", "required": [ "fileSystemId" ], "members": { "fileSystemId": { "shape": "String", "documentation": "The Amazon EFS file system ID to use.
" }, "rootDirectory": { "shape": "String", "documentation": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
" }, "authorizationConfig": { "shape": "EFSAuthorizationConfig", "documentation": "The authorization configuration details for the Amazon EFS file system.
" } }, "documentation": "This parameter is specified when you are 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.
" }, "EnvironmentFile": { "type": "structure", "required": [ "value", "type" ], "members": { "value": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.
" }, "type": { "shape": "EnvironmentFileType", "documentation": "The file type to use. The only supported value is s3.
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 on the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.
This field is not valid for containers in tasks using the Fargate launch type.
" }, "EnvironmentFileType": { "type": "string", "enum": [ "s3" ] }, "EnvironmentFiles": { "type": "list", "member": { "shape": "EnvironmentFile" } }, "EnvironmentVariables": { "type": "list", "member": { "shape": "KeyValuePair" } }, "Failure": { "type": "structure", "members": { "arn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the failed resource.
" }, "reason": { "shape": "String", "documentation": "The reason for the failure.
" }, "detail": { "shape": "String", "documentation": "The details of the failure.
" } }, "documentation": "A failed resource.
" }, "Failures": { "type": "list", "member": { "shape": "Failure" } }, "FirelensConfiguration": { "type": "structure", "required": [ "type" ], "members": { "type": { "shape": "FirelensConfigurationType", "documentation": "The log router to use. The valid values are fluentd or fluentbit.
The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is \"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}. For more information, see Creating a Task Definition that Uses a FireLens Configuration 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.
" }, "FirelensConfigurationOptionsMap": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "String" } }, "FirelensConfigurationType": { "type": "string", "enum": [ "fluentd", "fluentbit" ] }, "GpuIds": { "type": "list", "member": { "shape": "String" } }, "HealthCheck": { "type": "structure", "required": [ "command" ], "members": { "command": { "shape": "StringList", "documentation": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:
[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
" }, "timeout": { "shape": "BoxedInteger", "documentation": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
" }, "retries": { "shape": "BoxedInteger", "documentation": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
" }, "startPeriod": { "shape": "BoxedInteger", "documentation": "The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.
If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
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).
You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.
The following describes the possible healthStatus values for a container:
HEALTHY-The container health check has passed successfully.
UNHEALTHY-The container health check has failed.
UNKNOWN-The container health check is being evaluated or there is no container health check defined.
The following describes the possible healthStatus values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.
HEALTHY-All essential containers within the task have passed their health checks.
UNHEALTHY-One or more essential containers have failed their health check.
UNKNOWN-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.
The following are notes about container health check support:
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
The hostname to use in the /etc/hosts entry.
The IP address to use in the /etc/hosts entry.
Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath parameter is not supported.
Details on a container instance bind mount host volume.
" }, "InferenceAccelerator": { "type": "structure", "required": [ "deviceName", "deviceType" ], "members": { "deviceName": { "shape": "String", "documentation": "The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator type to use.
" } }, "documentation": "Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" }, "InferenceAcceleratorOverride": { "type": "structure", "members": { "deviceName": { "shape": "String", "documentation": "The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.
The Elastic Inference accelerator type to use.
" } }, "documentation": "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.
" }, "InferenceAcceleratorOverrides": { "type": "list", "member": { "shape": "InferenceAcceleratorOverride" } }, "InferenceAccelerators": { "type": "list", "member": { "shape": "InferenceAccelerator" } }, "Integer": { "type": "integer" }, "IpcMode": { "type": "string", "enum": [ "host", "task", "none" ] }, "KernelCapabilities": { "type": "structure", "members": { "add": { "shape": "StringList", "documentation": "The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.
The SYS_PTRACE capability is supported for tasks that use the Fargate launch type if they are also using platform version 1.4.0. The other capabilities are not supported for any platform versions.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
" }, "KeyValuePair": { "type": "structure", "members": { "name": { "shape": "String", "documentation": "The name of the key-value pair. For environment variables, this is the name of the environment variable.
" }, "value": { "shape": "String", "documentation": "The value of the key-value pair. For environment variables, this is the value of the environment variable.
" } }, "documentation": "A key-value pair object.
" }, "LaunchType": { "type": "string", "enum": [ "EC2", "FARGATE" ] }, "LinuxParameters": { "type": "structure", "members": { "capabilities": { "shape": "KernelCapabilities", "documentation": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
If you are using tasks that use the Fargate launch type, the devices parameter is not supported.
Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.
The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
If you are using tasks that use the Fargate launch type, the maxSwap parameter is not supported.
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
If you are using tasks that use the Fargate launch type, the swappiness parameter is not supported.
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
" }, "ListAccountSettingsRequest": { "type": "structure", "members": { "name": { "shape": "SettingName", "documentation": "The resource name you want to list the account settings for.
" }, "value": { "shape": "String", "documentation": "The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.
" }, "principalArn": { "shape": "String", "documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
" }, "effectiveSettings": { "shape": "Boolean", "documentation": "Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.
The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.
The account settings for the resource.
" }, "nextToken": { "shape": "String", "documentation": "The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
" }, "targetType": { "shape": "TargetType", "documentation": "The type of the target with which to list attributes.
" }, "attributeName": { "shape": "String", "documentation": "The name of the attribute with which to filter the results.
" }, "attributeValue": { "shape": "String", "documentation": "The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.
" }, "nextToken": { "shape": "String", "documentation": "The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.
A list of attribute objects that meet the criteria of the request.
" }, "nextToken": { "shape": "String", "documentation": "The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
" }, "nextToken": { "shape": "String", "documentation": "The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
" }, "filter": { "shape": "String", "documentation": "You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
" }, "nextToken": { "shape": "String", "documentation": "The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.
" }, "nextToken": { "shape": "String", "documentation": "The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The maximum number of service results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.
The launch type for the services to list.
" }, "schedulingStrategy": { "shape": "SchedulingStrategy", "documentation": "The scheduling strategy for services to list.
" } } }, "ListServicesResponse": { "type": "structure", "members": { "serviceArns": { "shape": "StringList", "documentation": "The list of full ARN entries for each service associated with the specified cluster.
" }, "nextToken": { "shape": "String", "documentation": "The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "shape": "Tags", "documentation": "The tags for the resource.
" } } }, "ListTaskDefinitionFamiliesRequest": { "type": "structure", "members": { "familyPrefix": { "shape": "String", "documentation": "The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.
The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
The list of task definition family names that match the ListTaskDefinitionFamilies request.
The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.
The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.
The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.
" }, "containerInstance": { "shape": "String", "documentation": "The container instance ID or full ARN of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.
The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.
The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.
The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.
The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).
The launch type for services to list.
" } } }, "ListTasksResponse": { "type": "structure", "members": { "taskArns": { "shape": "StringList", "documentation": "The list of task ARN entries for the ListTasks request.
The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.
For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
The name of the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
" }, "containerName": { "shape": "String", "documentation": "The name of the container (as it appears in a container definition) to associate with the load balancer.
" }, "containerPort": { "shape": "BoxedInteger", "documentation": "The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
The load balancer configuration to use with a service or task set.
For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.
" }, "LoadBalancers": { "type": "list", "member": { "shape": "LoadBalancer" } }, "LogConfiguration": { "type": "structure", "required": [ "logDriver" ], "members": { "logDriver": { "shape": "LogDriver", "documentation": "The log driver to use for the container. The valid values listed earlier are log drivers that the Amazon ECS container agent can communicate with by default.
For tasks using the Fargate launch type, the supported log drivers are awslogs, splunk, and awsfirelens.
For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
" } }, "documentation": "The log configuration specification 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 . By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
The following should be noted when specifying a log configuration for your containers:
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
For tasks using the EC2 launch type, the Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, because you do not have access to the underlying infrastructure your tasks are hosted on, any additional software needed will have to be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
Whether or not to enable managed scaling for the capacity provider.
" }, "targetCapacity": { "shape": "ManagedScalingTargetCapacity", "documentation": "The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.
The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1 is used.
The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000 is used.
The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS-managed CloudWatch metric with the specified targetCapacity value as the target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.
" }, "ManagedScalingStatus": { "type": "string", "enum": [ "ENABLED", "DISABLED" ] }, "ManagedScalingStepSize": { "type": "integer", "max": 10000, "min": 1 }, "ManagedScalingTargetCapacity": { "type": "integer", "max": 100, "min": 1 }, "ManagedTerminationProtection": { "type": "string", "enum": [ "ENABLED", "DISABLED" ] }, "MountPoint": { "type": "structure", "members": { "sourceVolume": { "shape": "String", "documentation": "The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.
The path on the container to mount the host volume at.
" }, "readOnly": { "shape": "BoxedBoolean", "documentation": "If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
Details on a volume mount point that is used in a container definition.
" }, "MountPointList": { "type": "list", "member": { "shape": "MountPoint" } }, "NetworkBinding": { "type": "structure", "members": { "bindIP": { "shape": "String", "documentation": "The IP address that the container is bound to on the container instance.
" }, "containerPort": { "shape": "BoxedInteger", "documentation": "The port number on the container that is used with the network binding.
" }, "hostPort": { "shape": "BoxedInteger", "documentation": "The port number on the host that is used with the network binding.
" }, "protocol": { "shape": "TransportProtocol", "documentation": "The protocol used for the network binding.
" } }, "documentation": "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 VPC subnets and security groups associated with a task.
All specified subnets and security groups must be from the same VPC.
An object representing the network configuration for a task or service.
" }, "NetworkInterface": { "type": "structure", "members": { "attachmentId": { "shape": "String", "documentation": "The attachment ID for the network interface.
" }, "privateIpv4Address": { "shape": "String", "documentation": "The private IPv4 address for the network interface.
" }, "ipv6Address": { "shape": "String", "documentation": "The private IPv6 address for the network interface.
" } }, "documentation": "An object representing the elastic network interface for tasks that use the awsvpc network mode.
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
If you are using the Fargate launch type, task placement constraints are not supported.
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
" }, "PlacementStrategyType": { "type": "string", "enum": [ "random", "spread", "binpack" ] }, "PlatformDevice": { "type": "structure", "required": [ "id", "type" ], "members": { "id": { "shape": "String", "documentation": "The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.
The type of device that is available on the container instance. The only supported value is GPU.
The devices that are available on the container instance. The only supported device type is a GPU.
" }, "PlatformDeviceType": { "type": "string", "enum": [ "GPU" ] }, "PlatformDevices": { "type": "list", "member": { "shape": "PlatformDevice" } }, "PortMapping": { "type": "structure", "members": { "containerPort": { "shape": "BoxedInteger", "documentation": "The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.
If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted.
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.
If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.
The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.
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.
If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.
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 proxy type. The only supported value is APPMESH.
The name of the container that will serve as the App Mesh proxy.
" }, "properties": { "shape": "ProxyConfigurationProperties", "documentation": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.
IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty.
AppPorts - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort.
ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.
ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.
EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.
EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.
The configuration details for the App Mesh proxy.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.
" }, "ProxyConfigurationProperties": { "type": "list", "member": { "shape": "KeyValuePair" } }, "ProxyConfigurationType": { "type": "string", "enum": [ "APPMESH" ] }, "PutAccountSettingDefaultRequest": { "type": "structure", "required": [ "name", "value" ], "members": { "name": { "shape": "SettingName", "documentation": "The resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.
The account setting value for the specified principal ARN. Accepted values are enabled and disabled.
The Amazon ECS resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.
The account setting value for the specified principal ARN. Accepted values are enabled and disabled.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
" } } }, "PutAccountSettingResponse": { "type": "structure", "members": { "setting": { "shape": "Setting", "documentation": "The current account setting for a resource.
" } } }, "PutAttributesRequest": { "type": "structure", "required": [ "attributes" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.
" }, "attributes": { "shape": "Attributes", "documentation": "The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.
" } } }, "PutAttributesResponse": { "type": "structure", "members": { "attributes": { "shape": "Attributes", "documentation": "The attributes applied to your resource.
" } } }, "PutClusterCapacityProvidersRequest": { "type": "structure", "required": [ "cluster", "capacityProviders", "defaultCapacityProviderStrategy" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.
" }, "capacityProviders": { "shape": "StringList", "documentation": "The name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.
" }, "instanceIdentityDocument": { "shape": "String", "documentation": "The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
The resources available on the instance.
" }, "versionInfo": { "shape": "VersionInfo", "documentation": "The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
" }, "containerInstanceArn": { "shape": "String", "documentation": "The ARN of the container instance (if it was previously registered).
" }, "attributes": { "shape": "Attributes", "documentation": "The container instance attributes that this container instance supports.
" }, "platformDevices": { "shape": "PlatformDevices", "documentation": "The devices that are available on the container instance. The only supported device type is a GPU.
" }, "tags": { "shape": "Tags", "documentation": "The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The container instance that was registered.
" } } }, "RegisterTaskDefinitionRequest": { "type": "structure", "required": [ "family", "containerDefinitions" ], "members": { "family": { "shape": "String", "documentation": "You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
" }, "executionRoleArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
" }, "networkMode": { "shape": "NetworkMode", "documentation": "The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.
For more information, see Network settings in the Docker run reference.
" }, "containerDefinitions": { "shape": "ContainerDefinitions", "documentation": "A list of container definitions in JSON format that describe the different containers that make up your task.
" }, "volumes": { "shape": "VolumeList", "documentation": "A list of volume definitions in JSON format that containers in your task may use.
" }, "placementConstraints": { "shape": "TaskDefinitionPlacementConstraints", "documentation": "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 runtime).
" }, "requiresCompatibilities": { "shape": "CompatibilityList", "documentation": "The launch type required by the task. If no value is specified, it defaults to EC2.
The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The Elastic Inference accelerators to use for the containers in the task.
" } } }, "RegisterTaskDefinitionResponse": { "type": "structure", "members": { "taskDefinition": { "shape": "TaskDefinition", "documentation": "The full description of the registered task definition.
" }, "tags": { "shape": "Tags", "documentation": "The list of tags associated with the task definition.
" } } }, "RepositoryCredentials": { "type": "structure", "required": [ "credentialsParameter" ], "members": { "credentialsParameter": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.
The repository credentials for private registry authentication.
" }, "RequiresAttributes": { "type": "list", "member": { "shape": "Attribute" } }, "Resource": { "type": "structure", "members": { "name": { "shape": "String", "documentation": "The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.
The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.
When the doubleValue type is set, the value of the resource must be a double precision floating-point type.
When the longValue type is set, the value of the resource must be an extended precision floating-point type.
When the integerValue type is set, the value of the resource must be an integer.
When the stringSetValue type is set, the value of the resource must be a string type.
Describes the resources available for a container instance.
" }, "ResourceRequirement": { "type": "structure", "required": [ "value", "type" ], "members": { "value": { "shape": "String", "documentation": "The value for the specified resource type.
If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.
If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.
The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.
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
" }, "ResourceRequirements": { "type": "list", "member": { "shape": "ResourceRequirement" } }, "ResourceType": { "type": "string", "enum": [ "GPU", "InferenceAccelerator" ] }, "Resources": { "type": "list", "member": { "shape": "Resource" } }, "RunTaskRequest": { "type": "structure", "required": [ "taskDefinition" ], "members": { "capacityProviderStrategy": { "shape": "CapacityProviderStrategy", "documentation": "The capacity provider strategy to use for the task.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
" }, "count": { "shape": "BoxedInteger", "documentation": "The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
" }, "enableECSManagedTags": { "shape": "Boolean", "documentation": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" }, "group": { "shape": "String", "documentation": "The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
" }, "launchType": { "shape": "LaunchType", "documentation": "The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
" }, "placementStrategy": { "shape": "PlacementStrategies", "documentation": "The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
" }, "platformVersion": { "shape": "String", "documentation": "The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
An error will be received if you specify the SERVICE option when running a task.
The reference ID to use for the task.
" }, "startedBy": { "shape": "String", "documentation": "An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The family and revision (family:revision) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.
A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" } } }, "Scale": { "type": "structure", "members": { "value": { "shape": "Double", "documentation": "The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.
The unit of measure for the scale value.
" } }, "documentation": "A floating-point percentage of the desired number of tasks to place and keep running in the task set.
" }, "ScaleUnit": { "type": "string", "enum": [ "PERCENT" ] }, "SchedulingStrategy": { "type": "string", "enum": [ "REPLICA", "DAEMON" ] }, "Scope": { "type": "string", "enum": [ "task", "shared" ] }, "Secret": { "type": "structure", "required": [ "name", "valueFrom" ], "members": { "name": { "shape": "String", "documentation": "The name of the secret.
" }, "valueFrom": { "shape": "String", "documentation": "The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
" }, "SecretList": { "type": "list", "member": { "shape": "Secret" } }, "Service": { "type": "structure", "members": { "serviceArn": { "shape": "String", "documentation": "The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
" }, "clusterArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the cluster that hosts the service.
" }, "loadBalancers": { "shape": "LoadBalancers", "documentation": "A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
" }, "serviceRegistries": { "shape": "ServiceRegistries", "documentation": "The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
" }, "status": { "shape": "String", "documentation": "The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
" }, "runningCount": { "shape": "Integer", "documentation": "The number of tasks in the cluster that are in the RUNNING state.
The number of tasks in the cluster that are in the PENDING state.
The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
The capacity provider strategy associated with the service.
" }, "platformVersion": { "shape": "String", "documentation": "The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
" }, "deploymentConfiguration": { "shape": "DeploymentConfiguration", "documentation": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
" }, "taskSets": { "shape": "TaskSets", "documentation": "Information about a set of Amazon ECS tasks in either an AWS 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 current state of deployments for the service.
" }, "roleArn": { "shape": "String", "documentation": "The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
" }, "events": { "shape": "ServiceEvents", "documentation": "The event stream for your service. A maximum of 100 of the latest events are displayed.
" }, "createdAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the service was created.
" }, "placementConstraints": { "shape": "PlacementConstraints", "documentation": "The placement constraints for the tasks in the service.
" }, "placementStrategy": { "shape": "PlacementStrategies", "documentation": "The placement strategy that determines how tasks for the service are placed.
" }, "networkConfiguration": { "shape": "NetworkConfiguration", "documentation": "The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
" }, "schedulingStrategy": { "shape": "SchedulingStrategy", "documentation": "The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.
Fargate tasks do not support the DAEMON scheduling strategy.
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The principal that created the service.
" }, "enableECSManagedTags": { "shape": "Boolean", "documentation": "Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" }, "propagateTags": { "shape": "PropagateTags", "documentation": "Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
" } }, "documentation": "Details on a service within a cluster
" }, "ServiceEvent": { "type": "structure", "members": { "id": { "shape": "String", "documentation": "The ID string of the event.
" }, "createdAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the event was triggered.
" }, "message": { "shape": "String", "documentation": "The event message.
" } }, "documentation": "Details on an event associated with a service.
" }, "ServiceEvents": { "type": "list", "member": { "shape": "ServiceEvent" } }, "ServiceField": { "type": "string", "enum": [ "TAGS" ] }, "ServiceFieldList": { "type": "list", "member": { "shape": "ServiceField" } }, "ServiceRegistries": { "type": "list", "member": { "shape": "ServiceRegistry" } }, "ServiceRegistry": { "type": "structure", "members": { "registryArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService.
" }, "port": { "shape": "BoxedInteger", "documentation": "The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
Details of the service registry.
" }, "Services": { "type": "list", "member": { "shape": "Service" } }, "Setting": { "type": "structure", "members": { "name": { "shape": "SettingName", "documentation": "The Amazon ECS resource name.
" }, "value": { "shape": "String", "documentation": "Whether the account setting is enabled or disabled for the specified resource.
" }, "principalArn": { "shape": "String", "documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
" } }, "documentation": "The current account setting for a resource.
" }, "SettingName": { "type": "string", "enum": [ "serviceLongArnFormat", "taskLongArnFormat", "containerInstanceLongArnFormat", "awsvpcTrunking", "containerInsights" ] }, "Settings": { "type": "list", "member": { "shape": "Setting" } }, "SortOrder": { "type": "string", "enum": [ "ASC", "DESC" ] }, "StabilityStatus": { "type": "string", "enum": [ "STEADY_STATE", "STABILIZING" ] }, "StartTaskRequest": { "type": "structure", "required": [ "containerInstances", "taskDefinition" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
" }, "containerInstances": { "shape": "StringList", "documentation": "The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.
" }, "enableECSManagedTags": { "shape": "Boolean", "documentation": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" }, "group": { "shape": "String", "documentation": "The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
" }, "networkConfiguration": { "shape": "NetworkConfiguration", "documentation": "The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
" }, "referenceId": { "shape": "String", "documentation": "The reference ID to use for the task.
" }, "startedBy": { "shape": "String", "documentation": "An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.
A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" } } }, "Statistics": { "type": "list", "member": { "shape": "KeyValuePair" } }, "StopTaskRequest": { "type": "structure", "required": [ "task" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
" }, "task": { "shape": "String", "documentation": "The task ID or full Amazon Resource Name (ARN) of the task to stop.
" }, "reason": { "shape": "String", "documentation": "An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
" } } }, "StopTaskResponse": { "type": "structure", "members": { "task": { "shape": "Task", "documentation": "The task that was stopped.
" } } }, "String": { "type": "string" }, "StringList": { "type": "list", "member": { "shape": "String" } }, "StringMap": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "String" } }, "SubmitAttachmentStateChangesRequest": { "type": "structure", "required": [ "attachments" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.
" }, "attachments": { "shape": "AttachmentStateChanges", "documentation": "Any attachments associated with the state change request.
" } } }, "SubmitAttachmentStateChangesResponse": { "type": "structure", "members": { "acknowledgment": { "shape": "String", "documentation": "Acknowledgement of the state change.
" } } }, "SubmitContainerStateChangeRequest": { "type": "structure", "members": { "cluster": { "shape": "String", "documentation": "The short name or full ARN of the cluster that hosts the container.
" }, "task": { "shape": "String", "documentation": "The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
" }, "containerName": { "shape": "String", "documentation": "The name of the container.
" }, "runtimeId": { "shape": "String", "documentation": "The ID of the Docker container.
" }, "status": { "shape": "String", "documentation": "The status of the state change request.
" }, "exitCode": { "shape": "BoxedInteger", "documentation": "The exit code returned for the state change request.
" }, "reason": { "shape": "String", "documentation": "The reason for the state change request.
" }, "networkBindings": { "shape": "NetworkBindings", "documentation": "The network bindings of the container.
" } } }, "SubmitContainerStateChangeResponse": { "type": "structure", "members": { "acknowledgment": { "shape": "String", "documentation": "Acknowledgement of the state change.
" } } }, "SubmitTaskStateChangeRequest": { "type": "structure", "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
" }, "task": { "shape": "String", "documentation": "The task ID or full ARN of the task in the state change request.
" }, "status": { "shape": "String", "documentation": "The status of the state change request.
" }, "reason": { "shape": "String", "documentation": "The reason for the state change request.
" }, "containers": { "shape": "ContainerStateChanges", "documentation": "Any containers associated with the state change request.
" }, "attachments": { "shape": "AttachmentStateChanges", "documentation": "Any attachments associated with the state change request.
" }, "pullStartedAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the container image pull began.
" }, "pullStoppedAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the container image pull completed.
" }, "executionStoppedAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the task execution stopped.
" } } }, "SubmitTaskStateChangeResponse": { "type": "structure", "members": { "acknowledgment": { "shape": "String", "documentation": "Acknowledgement of the state change.
" } } }, "SystemControl": { "type": "structure", "members": { "namespace": { "shape": "String", "documentation": "The namespaced kernel parameter for which to set a value.
The value for the namespaced kernel parameter specified in namespace.
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.
It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:
For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that is started last determines which systemControls take effect.
For tasks that use the host network mode, the systemControls parameter applies to the container instance's kernel parameter as well as that of all containers of any tasks running on that container instance.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
" }, "tags": { "shape": "Tags", "documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
The attributes of the task
" }, "availabilityZone": { "shape": "String", "documentation": "The availability zone of the task.
" }, "capacityProviderName": { "shape": "String", "documentation": "The capacity provider associated with the task.
" }, "clusterArn": { "shape": "String", "documentation": "The ARN of the cluster that hosts the task.
" }, "connectivity": { "shape": "Connectivity", "documentation": "The connectivity status of a task.
" }, "connectivityAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the task last went into CONNECTED status.
The ARN of the container instances that host the task.
" }, "containers": { "shape": "Containers", "documentation": "The containers associated with the task.
" }, "cpu": { "shape": "String", "documentation": "The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The Unix timestamp for when the task was created (the task entered the PENDING state).
The desired status of the task. For more information, see Task Lifecycle.
" }, "executionStoppedAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the task execution stopped.
" }, "group": { "shape": "String", "documentation": "The name of the task group associated with the task.
" }, "healthStatus": { "shape": "HealthStatus", "documentation": "The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
The Elastic Inference accelerator associated with the task.
" }, "lastStatus": { "shape": "String", "documentation": "The last known status of the task. For more information, see Task Lifecycle.
" }, "launchType": { "shape": "LaunchType", "documentation": "The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" }, "memory": { "shape": "String", "documentation": "The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
One or more container overrides.
" }, "platformVersion": { "shape": "String", "documentation": "The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The Unix timestamp for when the container image pull began.
" }, "pullStoppedAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the container image pull completed.
" }, "startedAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
The reason that the task was stopped.
" }, "stoppingAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the task.
" }, "taskDefinitionArn": { "shape": "String", "documentation": "The ARN of the task definition that creates the task.
" }, "version": { "shape": "Long", "documentation": "The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.
Details on a task in a cluster.
" }, "TaskDefinition": { "type": "structure", "members": { "taskDefinitionArn": { "shape": "String", "documentation": "The full Amazon Resource Name (ARN) of the task definition.
" }, "containerDefinitions": { "shape": "ContainerDefinitions", "documentation": "A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
" }, "family": { "shape": "String", "documentation": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.
" }, "taskRoleArn": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
The Amazon Resource Name (ARN) of the task execution role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
" }, "networkMode": { "shape": "NetworkMode", "documentation": "The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.
If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.
For more information, see Network settings in the Docker run reference.
" }, "revision": { "shape": "Integer", "documentation": "The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
The list of volume definitions for the task.
If your tasks are using the Fargate launch type, the host and sourcePath parameters are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
" }, "status": { "shape": "TaskDefinitionStatus", "documentation": "The status of the task definition.
" }, "requiresAttributes": { "shape": "RequiresAttributes", "documentation": "The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.
" }, "placementConstraints": { "shape": "TaskDefinitionPlacementConstraints", "documentation": "An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.
" }, "compatibilities": { "shape": "CompatibilityList", "documentation": "The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" }, "requiresCompatibilities": { "shape": "CompatibilityList", "documentation": "The launch type the task requires. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE.
The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount (in MiB) of memory used by the task.
If using the EC2 launch type, this field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional.
If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The Elastic Inference accelerator associated with the task.
" }, "pidMode": { "shape": "PidMode", "documentation": "The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The configuration details for the App Mesh proxy.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
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.
" }, "TaskDefinitionFamilyStatus": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "ALL" ] }, "TaskDefinitionField": { "type": "string", "enum": [ "TAGS" ] }, "TaskDefinitionFieldList": { "type": "list", "member": { "shape": "TaskDefinitionField" } }, "TaskDefinitionPlacementConstraint": { "type": "structure", "members": { "type": { "shape": "TaskDefinitionPlacementConstraintType", "documentation": "The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates.
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
" } }, "documentation": "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.
If you are using the Fargate launch type, task placement constraints are not supported.
One or more container overrides sent to a task.
" }, "cpu": { "shape": "String", "documentation": "The cpu override for the task.
" }, "inferenceAcceleratorOverrides": { "shape": "InferenceAcceleratorOverrides", "documentation": "The Elastic Inference accelerator override for the task.
" }, "executionRoleArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
" }, "memory": { "shape": "String", "documentation": "The memory override for the task.
" }, "taskRoleArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
" } }, "documentation": "The overrides associated with a task.
" }, "TaskSet": { "type": "structure", "members": { "id": { "shape": "String", "documentation": "The ID of the task set.
" }, "taskSetArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the task set.
" }, "serviceArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the service the task set exists in.
" }, "clusterArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
" }, "startedBy": { "shape": "String", "documentation": "The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
The status of the task set. The following describes each state:
The task set is serving production traffic.
The task set is not serving production traffic.
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
The task definition the task set is using.
" }, "computedDesiredCount": { "shape": "Integer", "documentation": "The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it is restarted after being in the STOPPED state.
The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.
The Unix timestamp for when the task set was created.
" }, "updatedAt": { "shape": "Timestamp", "documentation": "The Unix timestamp for when the task set was last updated.
" }, "launchType": { "shape": "LaunchType", "documentation": "The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" }, "capacityProviderStrategy": { "shape": "CapacityProviderStrategy", "documentation": "The capacity provider strategy associated with the task set.
" }, "platformVersion": { "shape": "String", "documentation": "The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The network configuration for the task set.
" }, "loadBalancers": { "shape": "LoadBalancers", "documentation": "Details on a load balancer that is used with a task set.
" }, "serviceRegistries": { "shape": "ServiceRegistries", "documentation": "The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
" }, "scale": { "shape": "Scale", "documentation": "A floating-point percentage of the desired number of tasks to place and keep running in the task set.
" }, "stabilityStatus": { "shape": "StabilityStatus", "documentation": "The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:
The task runningCount is equal to the computedDesiredCount.
The pendingCount is 0.
There are no tasks running on container instances in the DRAINING status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns STABILIZING.
The Unix timestamp for when the task set stability status was retrieved.
" }, "tags": { "shape": "Tags", "documentation": "The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
Information about a set of Amazon ECS tasks in either an AWS 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 absolute file path where the tmpfs volume is to be mounted.
" }, "size": { "shape": "Integer", "documentation": "The size (in MiB) of the tmpfs volume.
" }, "mountOptions": { "shape": "StringList", "documentation": "The list of tmpfs volume mount options.
Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"
The container path, mount options, and size of the tmpfs mount.
" }, "TmpfsList": { "type": "list", "member": { "shape": "Tmpfs" } }, "TransportProtocol": { "type": "string", "enum": [ "tcp", "udp" ] }, "Ulimit": { "type": "structure", "required": [ "name", "softLimit", "hardLimit" ], "members": { "name": { "shape": "UlimitName", "documentation": "The type of the ulimit.
The soft limit for the ulimit type.
" }, "hardLimit": { "shape": "Integer", "documentation": "The hard limit for the ulimit type.
" } }, "documentation": "The ulimit settings to pass to the container.
The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
" }, "tagKeys": { "shape": "TagKeys", "documentation": "The keys of the tags to be removed.
" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UpdateClusterSettingsRequest": { "type": "structure", "required": [ "cluster", "settings" ], "members": { "cluster": { "shape": "String", "documentation": "The name of the cluster to modify the settings for.
" }, "settings": { "shape": "ClusterSettings", "documentation": "The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
" }, "containerInstance": { "shape": "String", "documentation": "The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.
" } } }, "UpdateContainerAgentResponse": { "type": "structure", "members": { "containerInstance": { "shape": "ContainerInstance", "documentation": "The container instance for which the container agent was updated.
" } } }, "UpdateContainerInstancesStateRequest": { "type": "structure", "required": [ "containerInstances", "status" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.
" }, "containerInstances": { "shape": "StringList", "documentation": "A list of container instance IDs or full ARN entries.
" }, "status": { "shape": "ContainerInstanceStatus", "documentation": "The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.
The list of container instances.
" }, "failures": { "shape": "Failures", "documentation": "Any failures associated with the call.
" } } }, "UpdateServicePrimaryTaskSetRequest": { "type": "structure", "required": [ "cluster", "service", "primaryTaskSet" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
" }, "service": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
" }, "primaryTaskSet": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.
" } } }, "UpdateServicePrimaryTaskSetResponse": { "type": "structure", "members": { "taskSet": { "shape": "TaskSet" } } }, "UpdateServiceRequest": { "type": "structure", "required": [ "service" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
" }, "service": { "shape": "String", "documentation": "The name of the service to update.
" }, "desiredCount": { "shape": "BoxedInteger", "documentation": "The number of instantiations of the task to place and keep running in your service.
" }, "taskDefinition": { "shape": "String", "documentation": "The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "deploymentConfiguration": { "shape": "DeploymentConfiguration", "documentation": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
" }, "networkConfiguration": { "shape": "NetworkConfiguration" }, "placementConstraints": { "shape": "PlacementConstraints", "documentation": "An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
" }, "placementStrategy": { "shape": "PlacementStrategies", "documentation": "The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
" }, "platformVersion": { "shape": "String", "documentation": "The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" } } }, "UpdateServiceResponse": { "type": "structure", "members": { "service": { "shape": "Service", "documentation": "The full description of your service following the update call.
" } } }, "UpdateTaskSetRequest": { "type": "structure", "required": [ "cluster", "service", "taskSet", "scale" ], "members": { "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
" }, "service": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
" }, "taskSet": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the task set to update.
" }, "scale": { "shape": "Scale" } } }, "UpdateTaskSetResponse": { "type": "structure", "members": { "taskSet": { "shape": "TaskSet" } } }, "VersionInfo": { "type": "structure", "members": { "agentVersion": { "shape": "String", "documentation": "The version number of the Amazon ECS container agent.
" }, "agentHash": { "shape": "String", "documentation": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
" }, "dockerVersion": { "shape": "String", "documentation": "The Docker version running on the container instance.
" } }, "documentation": "The Docker and Amazon ECS container agent version information about a container instance.
" }, "Volume": { "type": "structure", "members": { "name": { "shape": "String", "documentation": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.
This parameter is specified when you are using an Amazon Elastic File System (Amazon EFS) file storage. Amazon EFS file systems are only supported when you are using the EC2 launch type.
EFSVolumeConfiguration remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms apply to your participation in this preview of EFSVolumeConfiguration.
A data volume used in a task definition. 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.
The name of another container within the same task definition from which to mount volumes.
" }, "readOnly": { "shape": "BoxedBoolean", "documentation": "If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
Details on a data volume from another container in the same task definition.
" }, "VolumeFromList": { "type": "list", "member": { "shape": "VolumeFrom" } }, "VolumeList": { "type": "list", "member": { "shape": "Volume" } } }, "documentation": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.
Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
" }