public class AbstractAmazonECS extends Object implements AmazonECS
AmazonECS. Convenient method forms pass
through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException.| Modifier and Type | Method and 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
any
ACTIVE task definitions). |
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 supplied
family and
containerDefinitions. |
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 to
AmazonECS.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.
|
public void setEndpoint(String endpoint)
AmazonECS
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.
setEndpoint in interface AmazonECSendpoint - 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.public void setRegion(Region region)
AmazonECSAmazonECS.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.
setRegion in interface AmazonECSregion - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public CreateClusterResult createCluster(CreateClusterRequest request)
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.
createCluster in interface AmazonECSpublic CreateClusterResult createCluster()
AmazonECScreateCluster in interface AmazonECSAmazonECS.createCluster(CreateClusterRequest)public CreateServiceResult createService(CreateServiceRequest request)
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.
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.
createService in interface AmazonECSpublic DeleteClusterResult deleteCluster(DeleteClusterRequest request)
AmazonECSDeletes 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.
deleteCluster in interface AmazonECSpublic DeleteServiceResult deleteService(DeleteServiceRequest request)
AmazonECSDeletes 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.
deleteService in interface AmazonECSpublic DeregisterContainerInstanceResult deregisterContainerInstance(DeregisterContainerInstanceRequest request)
AmazonECSDeregisters 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.
When you terminate a container instance, it is automatically deregistered from your cluster.
deregisterContainerInstance in interface AmazonECSpublic DeregisterTaskDefinitionResult deregisterTaskDefinition(DeregisterTaskDefinitionRequest request)
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).
deregisterTaskDefinition in interface AmazonECSpublic DescribeClustersResult describeClusters(DescribeClustersRequest request)
AmazonECSDescribes one or more of your clusters.
describeClusters in interface AmazonECSpublic DescribeClustersResult describeClusters()
AmazonECSdescribeClusters in interface AmazonECSAmazonECS.describeClusters(DescribeClustersRequest)public DescribeContainerInstancesResult describeContainerInstances(DescribeContainerInstancesRequest request)
AmazonECSDescribes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
describeContainerInstances in interface AmazonECSpublic DescribeServicesResult describeServices(DescribeServicesRequest request)
AmazonECSDescribes the specified services running in your cluster.
describeServices in interface AmazonECSpublic DescribeTaskDefinitionResult describeTaskDefinition(DescribeTaskDefinitionRequest request)
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.
describeTaskDefinition in interface AmazonECSpublic DescribeTasksResult describeTasks(DescribeTasksRequest request)
AmazonECSDescribes a specified task or tasks.
describeTasks in interface AmazonECSpublic DiscoverPollEndpointResult discoverPollEndpoint(DiscoverPollEndpointRequest request)
AmazonECSThis 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.
discoverPollEndpoint in interface AmazonECSpublic DiscoverPollEndpointResult discoverPollEndpoint()
AmazonECSdiscoverPollEndpoint in interface AmazonECSAmazonECS.discoverPollEndpoint(DiscoverPollEndpointRequest)public ListClustersResult listClusters(ListClustersRequest request)
AmazonECSReturns a list of existing clusters.
listClusters in interface AmazonECSpublic ListClustersResult listClusters()
AmazonECSlistClusters in interface AmazonECSAmazonECS.listClusters(ListClustersRequest)public ListContainerInstancesResult listContainerInstances(ListContainerInstancesRequest request)
AmazonECSReturns a list of container instances in a specified cluster.
listContainerInstances in interface AmazonECSpublic ListContainerInstancesResult listContainerInstances()
AmazonECSlistContainerInstances in interface AmazonECSAmazonECS.listContainerInstances(ListContainerInstancesRequest)public ListServicesResult listServices(ListServicesRequest request)
AmazonECSLists the services that are running in a specified cluster.
listServices in interface AmazonECSpublic ListServicesResult listServices()
AmazonECSlistServices in interface AmazonECSAmazonECS.listServices(ListServicesRequest)public ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest request)
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 definitions). You can filter the results
with the familyPrefix parameter.
listTaskDefinitionFamilies in interface AmazonECSpublic ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies()
AmazonECSlistTaskDefinitionFamilies in interface AmazonECSAmazonECS.listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest)public ListTaskDefinitionsResult listTaskDefinitions(ListTaskDefinitionsRequest request)
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.
listTaskDefinitions in interface AmazonECSpublic ListTaskDefinitionsResult listTaskDefinitions()
AmazonECSlistTaskDefinitions in interface AmazonECSAmazonECS.listTaskDefinitions(ListTaskDefinitionsRequest)public ListTasksResult listTasks(ListTasksRequest request)
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.
public ListTasksResult listTasks()
AmazonECSlistTasks in interface AmazonECSAmazonECS.listTasks(ListTasksRequest)public RegisterContainerInstanceResult registerContainerInstance(RegisterContainerInstanceRequest request)
AmazonECSThis 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.
registerContainerInstance in interface AmazonECSpublic RegisterTaskDefinitionResult registerTaskDefinition(RegisterTaskDefinitionRequest request)
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.
registerTaskDefinition in interface AmazonECSpublic RunTaskResult runTask(RunTaskRequest request)
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.
public StartTaskResult startTask(StartTaskRequest request)
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.
public StopTaskResult stopTask(StopTaskRequest request)
AmazonECSStops 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.
public SubmitContainerStateChangeResult submitContainerStateChange(SubmitContainerStateChangeRequest request)
AmazonECSThis 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.
submitContainerStateChange in interface AmazonECSpublic SubmitContainerStateChangeResult submitContainerStateChange()
AmazonECSsubmitContainerStateChange in interface AmazonECSAmazonECS.submitContainerStateChange(SubmitContainerStateChangeRequest)public SubmitTaskStateChangeResult submitTaskStateChange(SubmitTaskStateChangeRequest request)
AmazonECSThis 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.
submitTaskStateChange in interface AmazonECSpublic UpdateContainerAgentResult updateContainerAgent(UpdateContainerAgentRequest request)
AmazonECSUpdates 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.
updateContainerAgent in interface AmazonECSpublic UpdateServiceResult updateService(UpdateServiceRequest request)
AmazonECSModifies 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.
updateService in interface AmazonECSpublic void shutdown()
AmazonECSpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonECSResponse 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.
getCachedResponseMetadata in interface AmazonECSrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.