Class AbstractAmazonECS
- java.lang.Object
-
- com.amazonaws.services.ecs.AbstractAmazonECS
-
- All Implemented Interfaces:
AmazonECS
- Direct Known Subclasses:
AbstractAmazonECSAsync
public class AbstractAmazonECS extends Object implements AmazonECS
Abstract implementation ofAmazonECS
. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAmazonECS()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateClusterResult
createCluster()
Simplified method form for invoking the CreateCluster operation.CreateClusterResult
createCluster(CreateClusterRequest request)
Creates a new Amazon ECS cluster.CreateServiceResult
createService(CreateServiceRequest request)
Runs and maintains a desired number of tasks from a specified task definition.DeleteClusterResult
deleteCluster(DeleteClusterRequest request)
Deletes the specified cluster.DeleteServiceResult
deleteService(DeleteServiceRequest request)
Deletes a specified service within a cluster.DeregisterContainerInstanceResult
deregisterContainerInstance(DeregisterContainerInstanceRequest request)
Deregisters an Amazon ECS container instance from the specified cluster.DeregisterTaskDefinitionResult
deregisterTaskDefinition(DeregisterTaskDefinitionRequest request)
Deregisters the specified task definition by family and revision.DescribeClustersResult
describeClusters()
Simplified method form for invoking the DescribeClusters operation.DescribeClustersResult
describeClusters(DescribeClustersRequest request)
Describes one or more of your clusters.DescribeContainerInstancesResult
describeContainerInstances(DescribeContainerInstancesRequest request)
Describes Amazon EC2 Container Service container instances.DescribeServicesResult
describeServices(DescribeServicesRequest request)
Describes the specified services running in your cluster.DescribeTaskDefinitionResult
describeTaskDefinition(DescribeTaskDefinitionRequest request)
Describes a task definition.DescribeTasksResult
describeTasks(DescribeTasksRequest request)
Describes a specified task or tasks.DiscoverPollEndpointResult
discoverPollEndpoint()
Simplified method form for invoking the DiscoverPollEndpoint operation.DiscoverPollEndpointResult
discoverPollEndpoint(DiscoverPollEndpointRequest request)
ResponseMetadata
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.ListClustersResult
listClusters()
Simplified method form for invoking the ListClusters operation.ListClustersResult
listClusters(ListClustersRequest request)
Returns a list of existing clusters.ListContainerInstancesResult
listContainerInstances()
Simplified method form for invoking the ListContainerInstances operation.ListContainerInstancesResult
listContainerInstances(ListContainerInstancesRequest request)
Returns a list of container instances in a specified cluster.ListServicesResult
listServices()
Simplified method form for invoking the ListServices operation.ListServicesResult
listServices(ListServicesRequest request)
Lists the services that are running in a specified cluster.ListTaskDefinitionFamiliesResult
listTaskDefinitionFamilies()
Simplified method form for invoking the ListTaskDefinitionFamilies operation.ListTaskDefinitionFamiliesResult
listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest request)
Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have anyACTIVE
task definition revisions).ListTaskDefinitionsResult
listTaskDefinitions()
Simplified method form for invoking the ListTaskDefinitions operation.ListTaskDefinitionsResult
listTaskDefinitions(ListTaskDefinitionsRequest request)
Returns a list of task definitions that are registered to your account.ListTasksResult
listTasks()
Simplified method form for invoking the ListTasks operation.ListTasksResult
listTasks(ListTasksRequest request)
Returns a list of tasks for a specified cluster.RegisterContainerInstanceResult
registerContainerInstance(RegisterContainerInstanceRequest request)
RegisterTaskDefinitionResult
registerTaskDefinition(RegisterTaskDefinitionRequest request)
Registers a new task definition from the suppliedfamily
andcontainerDefinitions
.RunTaskResult
runTask(RunTaskRequest request)
Start a task using random placement and the default Amazon ECS scheduler.void
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://ecs.us-east-1.amazonaws.com").void
setRegion(Region region)
An alternative toAmazonECS.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.StartTaskResult
startTask(StartTaskRequest request)
Starts a new task from the specified task definition on the specified container instance or instances.StopTaskResult
stopTask(StopTaskRequest request)
Stops a running task.SubmitContainerStateChangeResult
submitContainerStateChange()
Simplified method form for invoking the SubmitContainerStateChange operation.SubmitContainerStateChangeResult
submitContainerStateChange(SubmitContainerStateChangeRequest request)
SubmitTaskStateChangeResult
submitTaskStateChange(SubmitTaskStateChangeRequest request)
UpdateContainerAgentResult
updateContainerAgent(UpdateContainerAgentRequest request)
Updates the Amazon ECS container agent on a specified container instance.UpdateServiceResult
updateService(UpdateServiceRequest request)
Modifies the desired count, deployment configuration, or task definition used in a service.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AmazonECS
Overrides the default endpoint for this client ("https://ecs.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "ecs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://ecs.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonECS
- Parameters:
endpoint
- The endpoint (ex: "ecs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://ecs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
public void setRegion(Region region)
Description copied from interface:AmazonECS
An alternative toAmazonECS.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAmazonECS
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
createCluster
public CreateClusterResult createCluster(CreateClusterRequest request)
Description copied from interface:AmazonECS
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 theCreateCluster
action.- Specified by:
createCluster
in interfaceAmazonECS
- Returns:
- Result of the CreateCluster operation returned by the service.
-
createCluster
public CreateClusterResult createCluster()
Description copied from interface:AmazonECS
Simplified method form for invoking the CreateCluster operation.- Specified by:
createCluster
in interfaceAmazonECS
- See Also:
AmazonECS.createCluster(CreateClusterRequest)
-
createService
public CreateServiceResult createService(CreateServiceRequest request)
Description copied from interface:AmazonECS
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below
desiredCount
, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see UpdateService.In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service.
You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an UpdateService operation), the service scheduler uses the
minimumHealthyPercent
andmaximumPercent
parameters to determine the deployment strategy.If the
minimumHealthyPercent
is below 100%, the scheduler can ignore thedesiredCount
temporarily during a deployment. For example, if your service has adesiredCount
of four tasks, aminimumHealthyPercent
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 theRUNNING
state; tasks for services that do use a load balancer are considered healthy if they are in theRUNNING
state and the container instance it is hosted on is reported as healthy by the load balancer. The default value forminimumHealthyPercent
is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.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 your service has adesiredCount
of four tasks, amaximumPercent
value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value formaximumPercent
is 200%.When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones 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).
-
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.
- Specified by:
createService
in interfaceAmazonECS
- Returns:
- Result of the CreateService operation returned by the service.
-
-
deleteCluster
public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
Description copied from interface:AmazonECS
Deletes the specified cluster. 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.
- Specified by:
deleteCluster
in interfaceAmazonECS
- Returns:
- Result of the DeleteCluster operation returned by the service.
-
deleteService
public DeleteServiceResult deleteService(DeleteServiceRequest request)
Description copied from interface:AmazonECS
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
toDRAINING
, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves fromDRAINING
toINACTIVE
. Services in theDRAINING
orINACTIVE
status can still be viewed with DescribeServices API operations; however, in the future,INACTIVE
services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return aServiceNotFoundException
error.- Specified by:
deleteService
in interfaceAmazonECS
- Returns:
- Result of the DeleteService operation returned by the service.
-
deregisterContainerInstance
public DeregisterContainerInstanceResult deregisterContainerInstance(DeregisterContainerInstanceRequest request)
Description copied from interface:AmazonECS
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 to avoid 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 with a connected Amazon ECS container agent, the agent automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
- Specified by:
deregisterContainerInstance
in interfaceAmazonECS
- Returns:
- Result of the DeregisterContainerInstance operation returned by the service.
-
deregisterTaskDefinition
public DeregisterTaskDefinitionResult deregisterTaskDefinition(DeregisterTaskDefinitionRequest request)
Description copied from interface:AmazonECS
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as
INACTIVE
. Existing tasks and services that reference anINACTIVE
task definition continue to run without disruption. Existing services that reference anINACTIVE
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 anINACTIVE
task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).- Specified by:
deregisterTaskDefinition
in interfaceAmazonECS
- Returns:
- Result of the DeregisterTaskDefinition operation returned by the service.
-
describeClusters
public DescribeClustersResult describeClusters(DescribeClustersRequest request)
Description copied from interface:AmazonECS
Describes one or more of your clusters.
- Specified by:
describeClusters
in interfaceAmazonECS
- Returns:
- Result of the DescribeClusters operation returned by the service.
-
describeClusters
public DescribeClustersResult describeClusters()
Description copied from interface:AmazonECS
Simplified method form for invoking the DescribeClusters operation.- Specified by:
describeClusters
in interfaceAmazonECS
- See Also:
AmazonECS.describeClusters(DescribeClustersRequest)
-
describeContainerInstances
public DescribeContainerInstancesResult describeContainerInstances(DescribeContainerInstancesRequest request)
Description copied from interface:AmazonECS
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
- Specified by:
describeContainerInstances
in interfaceAmazonECS
- Returns:
- Result of the DescribeContainerInstances operation returned by the service.
-
describeServices
public DescribeServicesResult describeServices(DescribeServicesRequest request)
Description copied from interface:AmazonECS
Describes the specified services running in your cluster.
- Specified by:
describeServices
in interfaceAmazonECS
- Returns:
- Result of the DescribeServices operation returned by the service.
-
describeTaskDefinition
public DescribeTaskDefinitionResult describeTaskDefinition(DescribeTaskDefinitionRequest request)
Description copied from interface:AmazonECS
Describes a task definition. You can specify a
family
andrevision
to find information about a specific task definition, or you can simply specify the family to find the latestACTIVE
revision in that family.You can only describe
INACTIVE
task definitions while an active task or service references them.- Specified by:
describeTaskDefinition
in interfaceAmazonECS
- Returns:
- Result of the DescribeTaskDefinition operation returned by the service.
-
describeTasks
public DescribeTasksResult describeTasks(DescribeTasksRequest request)
Description copied from interface:AmazonECS
Describes a specified task or tasks.
- Specified by:
describeTasks
in interfaceAmazonECS
- Returns:
- Result of the DescribeTasks operation returned by the service.
-
discoverPollEndpoint
public DiscoverPollEndpointResult discoverPollEndpoint(DiscoverPollEndpointRequest request)
Description copied from interface:AmazonECS
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
- Specified by:
discoverPollEndpoint
in interfaceAmazonECS
- Returns:
- Result of the DiscoverPollEndpoint operation returned by the service.
-
discoverPollEndpoint
public DiscoverPollEndpointResult discoverPollEndpoint()
Description copied from interface:AmazonECS
Simplified method form for invoking the DiscoverPollEndpoint operation.- Specified by:
discoverPollEndpoint
in interfaceAmazonECS
- See Also:
AmazonECS.discoverPollEndpoint(DiscoverPollEndpointRequest)
-
listClusters
public ListClustersResult listClusters(ListClustersRequest request)
Description copied from interface:AmazonECS
Returns a list of existing clusters.
- Specified by:
listClusters
in interfaceAmazonECS
- Returns:
- Result of the ListClusters operation returned by the service.
-
listClusters
public ListClustersResult listClusters()
Description copied from interface:AmazonECS
Simplified method form for invoking the ListClusters operation.- Specified by:
listClusters
in interfaceAmazonECS
- See Also:
AmazonECS.listClusters(ListClustersRequest)
-
listContainerInstances
public ListContainerInstancesResult listContainerInstances(ListContainerInstancesRequest request)
Description copied from interface:AmazonECS
Returns a list of container instances in a specified cluster.
- Specified by:
listContainerInstances
in interfaceAmazonECS
- Returns:
- Result of the ListContainerInstances operation returned by the service.
-
listContainerInstances
public ListContainerInstancesResult listContainerInstances()
Description copied from interface:AmazonECS
Simplified method form for invoking the ListContainerInstances operation.- Specified by:
listContainerInstances
in interfaceAmazonECS
- See Also:
AmazonECS.listContainerInstances(ListContainerInstancesRequest)
-
listServices
public ListServicesResult listServices(ListServicesRequest request)
Description copied from interface:AmazonECS
Lists the services that are running in a specified cluster.
- Specified by:
listServices
in interfaceAmazonECS
- Returns:
- Result of the ListServices operation returned by the service.
-
listServices
public ListServicesResult listServices()
Description copied from interface:AmazonECS
Simplified method form for invoking the ListServices operation.- Specified by:
listServices
in interfaceAmazonECS
- See Also:
AmazonECS.listServices(ListServicesRequest)
-
listTaskDefinitionFamilies
public ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest request)
Description copied from interface:AmazonECS
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 thestatus
parameter toACTIVE
. You can also filter the results with thefamilyPrefix
parameter.- Specified by:
listTaskDefinitionFamilies
in interfaceAmazonECS
- Returns:
- Result of the ListTaskDefinitionFamilies operation returned by the service.
-
listTaskDefinitionFamilies
public ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies()
Description copied from interface:AmazonECS
Simplified method form for invoking the ListTaskDefinitionFamilies operation.- Specified by:
listTaskDefinitionFamilies
in interfaceAmazonECS
- See Also:
AmazonECS.listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest)
-
listTaskDefinitions
public ListTaskDefinitionsResult listTaskDefinitions(ListTaskDefinitionsRequest request)
Description copied from interface:AmazonECS
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 thestatus
parameter.- Specified by:
listTaskDefinitions
in interfaceAmazonECS
- Returns:
- Result of the ListTaskDefinitions operation returned by the service.
-
listTaskDefinitions
public ListTaskDefinitionsResult listTaskDefinitions()
Description copied from interface:AmazonECS
Simplified method form for invoking the ListTaskDefinitions operation.- Specified by:
listTaskDefinitions
in interfaceAmazonECS
- See Also:
AmazonECS.listTaskDefinitions(ListTaskDefinitionsRequest)
-
listTasks
public ListTasksResult listTasks(ListTasksRequest request)
Description copied from interface:AmazonECS
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
, anddesiredStatus
parameters.
-
listTasks
public ListTasksResult listTasks()
Description copied from interface:AmazonECS
Simplified method form for invoking the ListTasks operation.- Specified by:
listTasks
in interfaceAmazonECS
- See Also:
AmazonECS.listTasks(ListTasksRequest)
-
registerContainerInstance
public RegisterContainerInstanceResult registerContainerInstance(RegisterContainerInstanceRequest request)
Description copied from interface:AmazonECS
This action is only used by the Amazon EC2 Container Service 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.
- Specified by:
registerContainerInstance
in interfaceAmazonECS
- Returns:
- Result of the RegisterContainerInstance operation returned by the service.
-
registerTaskDefinition
public RegisterTaskDefinitionResult registerTaskDefinition(RegisterTaskDefinitionRequest request)
Description copied from interface:AmazonECS
Registers a new task definition from the supplied
family
andcontainerDefinitions
. Optionally, you can add data volumes to your containers with thevolumes
parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.- Specified by:
registerTaskDefinition
in interfaceAmazonECS
- Returns:
- Result of the RegisterTaskDefinition operation returned by the service.
-
runTask
public RunTaskResult runTask(RunTaskRequest request)
Description copied from interface:AmazonECS
Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use
StartTask
instead.The
count
parameter is limited to 10 tasks per call.
-
startTask
public StartTaskResult startTask(StartTaskRequest request)
Description copied from interface:AmazonECS
Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use
RunTask
instead.The list of container instances to start tasks on is limited to 10.
-
stopTask
public StopTaskResult stopTask(StopTaskRequest request)
Description copied from interface:AmazonECS
Stops a running task.
When StopTask is called on a task, the equivalent of
docker stop
is issued to the containers running in the task. This results in aSIGTERM
and a 30-second timeout, after whichSIGKILL
is sent and the containers are forcibly stopped. If the container handles theSIGTERM
gracefully and exits within 30 seconds from receiving it, noSIGKILL
is sent.
-
submitContainerStateChange
public SubmitContainerStateChangeResult submitContainerStateChange(SubmitContainerStateChangeRequest request)
Description copied from interface:AmazonECS
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
- Specified by:
submitContainerStateChange
in interfaceAmazonECS
- Returns:
- Result of the SubmitContainerStateChange operation returned by the service.
-
submitContainerStateChange
public SubmitContainerStateChangeResult submitContainerStateChange()
Description copied from interface:AmazonECS
Simplified method form for invoking the SubmitContainerStateChange operation.- Specified by:
submitContainerStateChange
in interfaceAmazonECS
- See Also:
AmazonECS.submitContainerStateChange(SubmitContainerStateChangeRequest)
-
submitTaskStateChange
public SubmitTaskStateChangeResult submitTaskStateChange(SubmitTaskStateChangeRequest request)
Description copied from interface:AmazonECS
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
- Specified by:
submitTaskStateChange
in interfaceAmazonECS
- Returns:
- Result of the SubmitTaskStateChange operation returned by the service.
-
updateContainerAgent
public UpdateContainerAgentResult updateContainerAgent(UpdateContainerAgentRequest request)
Description copied from interface:AmazonECS
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 theecs-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 EC2 Container Service Developer Guide.- Specified by:
updateContainerAgent
in interfaceAmazonECS
- Returns:
- Result of the UpdateContainerAgent operation returned by the service.
-
updateService
public UpdateServiceResult updateService(UpdateServiceRequest request)
Description copied from interface:AmazonECS
Modifies the desired count, deployment configuration, or task definition used in a service.
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.You can use UpdateService to modify your task definition and deploy a new version of your service.
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
andmaximumPercent
, to determine the deployment strategy.If the
minimumHealthyPercent
is below 100%, the scheduler can ignore thedesiredCount
temporarily during a deployment. For example, if your service has adesiredCount
of four tasks, aminimumHealthyPercent
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 theRUNNING
state; tasks for services that do use a load balancer are considered healthy if they are in theRUNNING
state and the container instance it is 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 your service has adesiredCount
of four tasks, amaximumPercent
value 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 aSIGTERM
and a 30-second timeout, after whichSIGKILL
is sent and the containers are forcibly stopped. If the container handles theSIGTERM
gracefully and exits within 30 seconds from receiving it, noSIGKILL
is sent.When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones 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).
-
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.
- Specified by:
updateService
in interfaceAmazonECS
- Returns:
- Result of the UpdateService operation returned by the service.
-
-
shutdown
public void shutdown()
Description copied from interface:AmazonECS
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AmazonECS
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonECS
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-