Package com.amazonaws.services.ecs

Class AbstractAmazonECS

  • All Implemented Interfaces:
    AmazonECS
    Direct Known Subclasses:
    AbstractAmazonECSAsync
    public class AbstractAmazonECS
extends Object
implements AmazonECS
    Abstract implementation of AmazonECS. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

    • Constructor Detail

      • AbstractAmazonECS

        protected AbstractAmazonECS()

    • 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 interface AmazonECS
        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.

      • 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 the CreateCluster action.

        Specified by:
        createCluster in interface AmazonECS
        Returns:
        Result of the CreateCluster operation returned by the service.

      • 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 and maximumPercent parameters to determine the deployment strategy.

        If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent 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 do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent 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 a desiredCount of four tasks, a maximumPercent 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 for maximumPercent 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 interface AmazonECS
        Returns:
        Result of the CreateService 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 to DRAINING, 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 from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE 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 a ServiceNotFoundException error.

        Specified by:
        deleteService in interface AmazonECS
        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 interface AmazonECS
        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 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 (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).

        Specified by:
        deregisterTaskDefinition in interface AmazonECS
        Returns:
        Result of the DeregisterTaskDefinition 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 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.

        Specified by:
        describeTaskDefinition in interface AmazonECS
        Returns:
        Result of the DescribeTaskDefinition 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 interface AmazonECS
        Returns:
        Result of the DiscoverPollEndpoint operation returned by the service.

      • 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 the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

        Specified by:
        listTaskDefinitionFamilies in interface AmazonECS
        Returns:
        Result of the ListTaskDefinitionFamilies operation returned by the service.

      • 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 the status parameter.

        Specified by:
        listTaskDefinitions in interface AmazonECS
        Returns:
        Result of the ListTaskDefinitions operation returned by the service.

      • 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, and desiredStatus parameters.

        Specified by:
        listTasks in interface AmazonECS
        Returns:
        Result of the ListTasks operation returned by the service.

      • 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 interface AmazonECS
        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 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 EC2 Container Service Developer Guide.

        Specified by:
        registerTaskDefinition in interface AmazonECS
        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.

        Specified by:
        runTask in interface AmazonECS
        Returns:
        Result of the RunTask operation returned by the service.

      • 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.

        Specified by:
        startTask in interface AmazonECS
        Returns:
        Result of the StartTask operation returned by the service.

      • 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 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.

        Specified by:
        stopTask in interface AmazonECS
        Returns:
        Result of the StopTask operation returned by the service.

      • 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 interface AmazonECS
        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 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 EC2 Container Service Developer Guide.

        Specified by:
        updateContainerAgent in interface AmazonECS
        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 and maximumPercent, to determine the deployment strategy.

        If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent 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 do use a load balancer are considered healthy if they are in the RUNNING 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 a desiredCount of four tasks, a maximumPercent 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 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 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 interface AmazonECS
        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.
        Specified by:
        shutdown in interface AmazonECS

      • 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 interface AmazonECS
        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.