@Generated(value="software.amazon.awssdk:codegen") public interface EcsAsyncClient extends SdkClient
builder()
method.
Amazon EC2 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 of EC2 instances. Amazon ECS lets you launch and stop container-enabled 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 like security groups, Amazon EBS volumes, and IAM roles.
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 EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static EcsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
EcsAsyncClient . |
static EcsAsyncClient |
create()
Create a
EcsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateClusterResponse> |
createCluster()
Creates a new Amazon ECS cluster.
|
default CompletableFuture<CreateClusterResponse> |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates a new Amazon ECS cluster.
|
default CompletableFuture<CreateClusterResponse> |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new Amazon ECS cluster.
|
default CompletableFuture<CreateServiceResponse> |
createService(Consumer<CreateServiceRequest.Builder> createServiceRequest)
Runs and maintains a desired number of tasks from a specified task definition.
|
default CompletableFuture<CreateServiceResponse> |
createService(CreateServiceRequest createServiceRequest)
Runs and maintains a desired number of tasks from a specified task definition.
|
default CompletableFuture<DeleteAttributesResponse> |
deleteAttributes(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest)
Deletes one or more custom attributes from an Amazon ECS resource.
|
default CompletableFuture<DeleteAttributesResponse> |
deleteAttributes(DeleteAttributesRequest deleteAttributesRequest)
Deletes one or more custom attributes from an Amazon ECS resource.
|
default CompletableFuture<DeleteClusterResponse> |
deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes the specified cluster.
|
default CompletableFuture<DeleteClusterResponse> |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes the specified cluster.
|
default CompletableFuture<DeleteServiceResponse> |
deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest)
Deletes a specified service within a cluster.
|
default CompletableFuture<DeleteServiceResponse> |
deleteService(DeleteServiceRequest deleteServiceRequest)
Deletes a specified service within a cluster.
|
default CompletableFuture<DeregisterContainerInstanceResponse> |
deregisterContainerInstance(Consumer<DeregisterContainerInstanceRequest.Builder> deregisterContainerInstanceRequest)
Deregisters an Amazon ECS container instance from the specified cluster.
|
default CompletableFuture<DeregisterContainerInstanceResponse> |
deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest)
Deregisters an Amazon ECS container instance from the specified cluster.
|
default CompletableFuture<DeregisterTaskDefinitionResponse> |
deregisterTaskDefinition(Consumer<DeregisterTaskDefinitionRequest.Builder> deregisterTaskDefinitionRequest)
Deregisters the specified task definition by family and revision.
|
default CompletableFuture<DeregisterTaskDefinitionResponse> |
deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest)
Deregisters the specified task definition by family and revision.
|
default CompletableFuture<DescribeClustersResponse> |
describeClusters()
Describes one or more of your clusters.
|
default CompletableFuture<DescribeClustersResponse> |
describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Describes one or more of your clusters.
|
default CompletableFuture<DescribeClustersResponse> |
describeClusters(DescribeClustersRequest describeClustersRequest)
Describes one or more of your clusters.
|
default CompletableFuture<DescribeContainerInstancesResponse> |
describeContainerInstances(Consumer<DescribeContainerInstancesRequest.Builder> describeContainerInstancesRequest)
Describes Amazon EC2 Container Service container instances.
|
default CompletableFuture<DescribeContainerInstancesResponse> |
describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest)
Describes Amazon EC2 Container Service container instances.
|
default CompletableFuture<DescribeServicesResponse> |
describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
Describes the specified services running in your cluster.
|
default CompletableFuture<DescribeServicesResponse> |
describeServices(DescribeServicesRequest describeServicesRequest)
Describes the specified services running in your cluster.
|
default CompletableFuture<DescribeTaskDefinitionResponse> |
describeTaskDefinition(Consumer<DescribeTaskDefinitionRequest.Builder> describeTaskDefinitionRequest)
Describes a task definition.
|
default CompletableFuture<DescribeTaskDefinitionResponse> |
describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest)
Describes a task definition.
|
default CompletableFuture<DescribeTasksResponse> |
describeTasks(Consumer<DescribeTasksRequest.Builder> describeTasksRequest)
Describes a specified task or tasks.
|
default CompletableFuture<DescribeTasksResponse> |
describeTasks(DescribeTasksRequest describeTasksRequest)
Describes a specified task or tasks.
|
default CompletableFuture<DiscoverPollEndpointResponse> |
discoverPollEndpoint(Consumer<DiscoverPollEndpointRequest.Builder> discoverPollEndpointRequest)
|
default CompletableFuture<DiscoverPollEndpointResponse> |
discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest)
|
default CompletableFuture<ListAttributesResponse> |
listAttributes(Consumer<ListAttributesRequest.Builder> listAttributesRequest)
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
|
default CompletableFuture<ListAttributesResponse> |
listAttributes(ListAttributesRequest listAttributesRequest)
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
|
default CompletableFuture<ListClustersResponse> |
listClusters()
Returns a list of existing clusters.
|
default CompletableFuture<ListClustersResponse> |
listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns a list of existing clusters.
|
default CompletableFuture<ListClustersResponse> |
listClusters(ListClustersRequest listClustersRequest)
Returns a list of existing clusters.
|
default ListClustersPublisher |
listClustersPaginator()
Returns a list of existing clusters.
|
default ListClustersPublisher |
listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns a list of existing clusters.
|
default ListClustersPublisher |
listClustersPaginator(ListClustersRequest listClustersRequest)
Returns a list of existing clusters.
|
default CompletableFuture<ListContainerInstancesResponse> |
listContainerInstances()
Returns a list of container instances in a specified cluster.
|
default CompletableFuture<ListContainerInstancesResponse> |
listContainerInstances(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest)
Returns a list of container instances in a specified cluster.
|
default CompletableFuture<ListContainerInstancesResponse> |
listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest)
Returns a list of container instances in a specified cluster.
|
default ListContainerInstancesPublisher |
listContainerInstancesPaginator()
Returns a list of container instances in a specified cluster.
|
default ListContainerInstancesPublisher |
listContainerInstancesPaginator(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest)
Returns a list of container instances in a specified cluster.
|
default ListContainerInstancesPublisher |
listContainerInstancesPaginator(ListContainerInstancesRequest listContainerInstancesRequest)
Returns a list of container instances in a specified cluster.
|
default CompletableFuture<ListServicesResponse> |
listServices()
Lists the services that are running in a specified cluster.
|
default CompletableFuture<ListServicesResponse> |
listServices(Consumer<ListServicesRequest.Builder> listServicesRequest)
Lists the services that are running in a specified cluster.
|
default CompletableFuture<ListServicesResponse> |
listServices(ListServicesRequest listServicesRequest)
Lists the services that are running in a specified cluster.
|
default ListServicesPublisher |
listServicesPaginator()
Lists the services that are running in a specified cluster.
|
default ListServicesPublisher |
listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)
Lists the services that are running in a specified cluster.
|
default ListServicesPublisher |
listServicesPaginator(ListServicesRequest listServicesRequest)
Lists the services that are running in a specified cluster.
|
default CompletableFuture<ListTaskDefinitionFamiliesResponse> |
listTaskDefinitionFamilies()
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). |
default CompletableFuture<ListTaskDefinitionFamiliesResponse> |
listTaskDefinitionFamilies(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest)
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). |
default CompletableFuture<ListTaskDefinitionFamiliesResponse> |
listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest)
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). |
default ListTaskDefinitionFamiliesPublisher |
listTaskDefinitionFamiliesPaginator()
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). |
default ListTaskDefinitionFamiliesPublisher |
listTaskDefinitionFamiliesPaginator(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest)
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). |
default ListTaskDefinitionFamiliesPublisher |
listTaskDefinitionFamiliesPaginator(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest)
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). |
default CompletableFuture<ListTaskDefinitionsResponse> |
listTaskDefinitions()
Returns a list of task definitions that are registered to your account.
|
default CompletableFuture<ListTaskDefinitionsResponse> |
listTaskDefinitions(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest)
Returns a list of task definitions that are registered to your account.
|
default CompletableFuture<ListTaskDefinitionsResponse> |
listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest)
Returns a list of task definitions that are registered to your account.
|
default ListTaskDefinitionsPublisher |
listTaskDefinitionsPaginator()
Returns a list of task definitions that are registered to your account.
|
default ListTaskDefinitionsPublisher |
listTaskDefinitionsPaginator(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest)
Returns a list of task definitions that are registered to your account.
|
default ListTaskDefinitionsPublisher |
listTaskDefinitionsPaginator(ListTaskDefinitionsRequest listTaskDefinitionsRequest)
Returns a list of task definitions that are registered to your account.
|
default CompletableFuture<ListTasksResponse> |
listTasks()
Returns a list of tasks for a specified cluster.
|
default CompletableFuture<ListTasksResponse> |
listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks for a specified cluster.
|
default CompletableFuture<ListTasksResponse> |
listTasks(ListTasksRequest listTasksRequest)
Returns a list of tasks for a specified cluster.
|
default ListTasksPublisher |
listTasksPaginator()
Returns a list of tasks for a specified cluster.
|
default ListTasksPublisher |
listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks for a specified cluster.
|
default ListTasksPublisher |
listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of tasks for a specified cluster.
|
default CompletableFuture<PutAttributesResponse> |
putAttributes(Consumer<PutAttributesRequest.Builder> putAttributesRequest)
Create or update an attribute on an Amazon ECS resource.
|
default CompletableFuture<PutAttributesResponse> |
putAttributes(PutAttributesRequest putAttributesRequest)
Create or update an attribute on an Amazon ECS resource.
|
default CompletableFuture<RegisterContainerInstanceResponse> |
registerContainerInstance(Consumer<RegisterContainerInstanceRequest.Builder> registerContainerInstanceRequest)
|
default CompletableFuture<RegisterContainerInstanceResponse> |
registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest)
|
default CompletableFuture<RegisterTaskDefinitionResponse> |
registerTaskDefinition(Consumer<RegisterTaskDefinitionRequest.Builder> registerTaskDefinitionRequest)
Registers a new task definition from the supplied
family and containerDefinitions . |
default CompletableFuture<RegisterTaskDefinitionResponse> |
registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest)
Registers a new task definition from the supplied
family and containerDefinitions . |
default CompletableFuture<RunTaskResponse> |
runTask(Consumer<RunTaskRequest.Builder> runTaskRequest)
Starts a new task using the specified task definition.
|
default CompletableFuture<RunTaskResponse> |
runTask(RunTaskRequest runTaskRequest)
Starts a new task using the specified task definition.
|
default CompletableFuture<StartTaskResponse> |
startTask(Consumer<StartTaskRequest.Builder> startTaskRequest)
Starts a new task from the specified task definition on the specified container instance or instances.
|
default CompletableFuture<StartTaskResponse> |
startTask(StartTaskRequest startTaskRequest)
Starts a new task from the specified task definition on the specified container instance or instances.
|
default CompletableFuture<StopTaskResponse> |
stopTask(Consumer<StopTaskRequest.Builder> stopTaskRequest)
Stops a running task.
|
default CompletableFuture<StopTaskResponse> |
stopTask(StopTaskRequest stopTaskRequest)
Stops a running task.
|
default CompletableFuture<SubmitContainerStateChangeResponse> |
submitContainerStateChange(Consumer<SubmitContainerStateChangeRequest.Builder> submitContainerStateChangeRequest)
|
default CompletableFuture<SubmitContainerStateChangeResponse> |
submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest)
|
default CompletableFuture<SubmitTaskStateChangeResponse> |
submitTaskStateChange(Consumer<SubmitTaskStateChangeRequest.Builder> submitTaskStateChangeRequest)
|
default CompletableFuture<SubmitTaskStateChangeResponse> |
submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest)
|
default CompletableFuture<UpdateContainerAgentResponse> |
updateContainerAgent(Consumer<UpdateContainerAgentRequest.Builder> updateContainerAgentRequest)
Updates the Amazon ECS container agent on a specified container instance.
|
default CompletableFuture<UpdateContainerAgentResponse> |
updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest)
Updates the Amazon ECS container agent on a specified container instance.
|
default CompletableFuture<UpdateContainerInstancesStateResponse> |
updateContainerInstancesState(Consumer<UpdateContainerInstancesStateRequest.Builder> updateContainerInstancesStateRequest)
Modifies the status of an Amazon ECS container instance.
|
default CompletableFuture<UpdateContainerInstancesStateResponse> |
updateContainerInstancesState(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest)
Modifies the status of an Amazon ECS container instance.
|
default CompletableFuture<UpdateServiceResponse> |
updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest)
Modifies the desired count, deployment configuration, network configuration, or task definition used in a
service.
|
default CompletableFuture<UpdateServiceResponse> |
updateService(UpdateServiceRequest updateServiceRequest)
Modifies the desired count, deployment configuration, network configuration, or task definition used in a
service.
|
serviceName
close
static final String SERVICE_NAME
static EcsAsyncClient create()
EcsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static EcsAsyncClientBuilder builder()
EcsAsyncClient
.default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)
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 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 EC2 Container Service Developer Guide.
createClusterRequest
- default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
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 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 EC2 Container Service Developer Guide.
This is a convenience which creates an instance of the CreateClusterRequest.Builder
avoiding the need to
create one manually via CreateClusterRequest.builder()
createClusterRequest
- A Consumer
that will call methods on CreateClusterRequest.Builder
to create a request.default CompletableFuture<CreateClusterResponse> createCluster()
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 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 EC2 Container Service Developer Guide.
default CompletableFuture<CreateServiceResponse> createService(CreateServiceRequest createServiceRequest)
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 copy 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. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. During a deployment (which is triggered
by changing the task definition or the desired count of a service with an UpdateService operation), the
service scheduler uses the minimumHealthyPercent
and maximumPercent
parameters to
determine the deployment strategy.
The minimumHealthyPercent
represents a lower limit on the number of your service's tasks that must
remain in the RUNNING
state during a deployment, as a percentage of the desiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster
capacity. For example, if your service has a desiredCount
of four tasks and a
minimumHealthyPercent
of 50%, the scheduler can 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 the container instance they are 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 your service's tasks that
are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the
desiredCount
(rounded down to the nearest integer). This parameter enables you to define the
deployment batch size. For example, if your service has a desiredCount
of four tasks and a
maximumPercent
value of 200%, the scheduler can 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
maximumPercent
is 200%.
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 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.
createServiceRequest
- default CompletableFuture<CreateServiceResponse> createService(Consumer<CreateServiceRequest.Builder> createServiceRequest)
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 copy 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. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. During a deployment (which is triggered
by changing the task definition or the desired count of a service with an UpdateService operation), the
service scheduler uses the minimumHealthyPercent
and maximumPercent
parameters to
determine the deployment strategy.
The minimumHealthyPercent
represents a lower limit on the number of your service's tasks that must
remain in the RUNNING
state during a deployment, as a percentage of the desiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster
capacity. For example, if your service has a desiredCount
of four tasks and a
minimumHealthyPercent
of 50%, the scheduler can 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 the container instance they are 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 your service's tasks that
are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the
desiredCount
(rounded down to the nearest integer). This parameter enables you to define the
deployment batch size. For example, if your service has a desiredCount
of four tasks and a
maximumPercent
value of 200%, the scheduler can 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
maximumPercent
is 200%.
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 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.
This is a convenience which creates an instance of the CreateServiceRequest.Builder
avoiding the need to
create one manually via CreateServiceRequest.builder()
createServiceRequest
- A Consumer
that will call methods on CreateServiceRequest.Builder
to create a request.default CompletableFuture<DeleteAttributesResponse> deleteAttributes(DeleteAttributesRequest deleteAttributesRequest)
Deletes one or more custom attributes from an Amazon ECS resource.
deleteAttributesRequest
- default CompletableFuture<DeleteAttributesResponse> deleteAttributes(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest)
Deletes one or more custom attributes from an Amazon ECS resource.
This is a convenience which creates an instance of the DeleteAttributesRequest.Builder
avoiding the need
to create one manually via DeleteAttributesRequest.builder()
deleteAttributesRequest
- A Consumer
that will call methods on DeleteAttributesRequest.Builder
to create a request.default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)
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.
deleteClusterRequest
- default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
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.
This is a convenience which creates an instance of the DeleteClusterRequest.Builder
avoiding the need to
create one manually via DeleteClusterRequest.builder()
deleteClusterRequest
- A Consumer
that will call methods on DeleteClusterRequest.Builder
to create a request.default CompletableFuture<DeleteServiceResponse> deleteService(DeleteServiceRequest deleteServiceRequest)
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.
deleteServiceRequest
- default CompletableFuture<DeleteServiceResponse> deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest)
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.
This is a convenience which creates an instance of the DeleteServiceRequest.Builder
avoiding the need to
create one manually via DeleteServiceRequest.builder()
deleteServiceRequest
- A Consumer
that will call methods on DeleteServiceRequest.Builder
to create a request.default CompletableFuture<DeregisterContainerInstanceResponse> deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest)
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, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
deregisterContainerInstanceRequest
- default CompletableFuture<DeregisterContainerInstanceResponse> deregisterContainerInstance(Consumer<DeregisterContainerInstanceRequest.Builder> deregisterContainerInstanceRequest)
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, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
This is a convenience which creates an instance of the DeregisterContainerInstanceRequest.Builder
avoiding the need to create one manually via DeregisterContainerInstanceRequest.builder()
deregisterContainerInstanceRequest
- A Consumer
that will call methods on DeregisterContainerInstanceRequest.Builder
to create
a request.default CompletableFuture<DeregisterTaskDefinitionResponse> deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest)
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).
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 life cycle of any associated tasks and services.
deregisterTaskDefinitionRequest
- default CompletableFuture<DeregisterTaskDefinitionResponse> deregisterTaskDefinition(Consumer<DeregisterTaskDefinitionRequest.Builder> deregisterTaskDefinitionRequest)
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).
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 life cycle of any associated tasks and services.
This is a convenience which creates an instance of the DeregisterTaskDefinitionRequest.Builder
avoiding
the need to create one manually via DeregisterTaskDefinitionRequest.builder()
deregisterTaskDefinitionRequest
- A Consumer
that will call methods on DeregisterTaskDefinitionRequest.Builder
to create a
request.default CompletableFuture<DescribeClustersResponse> describeClusters(DescribeClustersRequest describeClustersRequest)
Describes one or more of your clusters.
describeClustersRequest
- default CompletableFuture<DescribeClustersResponse> describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Describes one or more of your clusters.
This is a convenience which creates an instance of the DescribeClustersRequest.Builder
avoiding the need
to create one manually via DescribeClustersRequest.builder()
describeClustersRequest
- A Consumer
that will call methods on DescribeClustersRequest.Builder
to create a request.default CompletableFuture<DescribeClustersResponse> describeClusters()
Describes one or more of your clusters.
default CompletableFuture<DescribeContainerInstancesResponse> describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest)
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
describeContainerInstancesRequest
- default CompletableFuture<DescribeContainerInstancesResponse> describeContainerInstances(Consumer<DescribeContainerInstancesRequest.Builder> describeContainerInstancesRequest)
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
This is a convenience which creates an instance of the DescribeContainerInstancesRequest.Builder
avoiding
the need to create one manually via DescribeContainerInstancesRequest.builder()
describeContainerInstancesRequest
- A Consumer
that will call methods on DescribeContainerInstancesRequest.Builder
to create a
request.default CompletableFuture<DescribeServicesResponse> describeServices(DescribeServicesRequest describeServicesRequest)
Describes the specified services running in your cluster.
describeServicesRequest
- default CompletableFuture<DescribeServicesResponse> describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
Describes the specified services running in your cluster.
This is a convenience which creates an instance of the DescribeServicesRequest.Builder
avoiding the need
to create one manually via DescribeServicesRequest.builder()
describeServicesRequest
- A Consumer
that will call methods on DescribeServicesRequest.Builder
to create a request.default CompletableFuture<DescribeTaskDefinitionResponse> describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest)
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.
describeTaskDefinitionRequest
- default CompletableFuture<DescribeTaskDefinitionResponse> describeTaskDefinition(Consumer<DescribeTaskDefinitionRequest.Builder> describeTaskDefinitionRequest)
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.
This is a convenience which creates an instance of the DescribeTaskDefinitionRequest.Builder
avoiding the
need to create one manually via DescribeTaskDefinitionRequest.builder()
describeTaskDefinitionRequest
- A Consumer
that will call methods on DescribeTaskDefinitionRequest.Builder
to create a
request.default CompletableFuture<DescribeTasksResponse> describeTasks(DescribeTasksRequest describeTasksRequest)
Describes a specified task or tasks.
describeTasksRequest
- default CompletableFuture<DescribeTasksResponse> describeTasks(Consumer<DescribeTasksRequest.Builder> describeTasksRequest)
Describes a specified task or tasks.
This is a convenience which creates an instance of the DescribeTasksRequest.Builder
avoiding the need to
create one manually via DescribeTasksRequest.builder()
describeTasksRequest
- A Consumer
that will call methods on DescribeTasksRequest.Builder
to create a request.default CompletableFuture<DiscoverPollEndpointResponse> discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest)
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.
discoverPollEndpointRequest
- default CompletableFuture<DiscoverPollEndpointResponse> discoverPollEndpoint(Consumer<DiscoverPollEndpointRequest.Builder> discoverPollEndpointRequest)
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.
This is a convenience which creates an instance of the DiscoverPollEndpointRequest.Builder
avoiding the
need to create one manually via DiscoverPollEndpointRequest.builder()
discoverPollEndpointRequest
- A Consumer
that will call methods on DiscoverPollEndpointRequest.Builder
to create a
request.default CompletableFuture<ListAttributesResponse> listAttributes(ListAttributesRequest listAttributesRequest)
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
).
listAttributesRequest
- default CompletableFuture<ListAttributesResponse> listAttributes(Consumer<ListAttributesRequest.Builder> listAttributesRequest)
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
).
This is a convenience which creates an instance of the ListAttributesRequest.Builder
avoiding the need to
create one manually via ListAttributesRequest.builder()
listAttributesRequest
- A Consumer
that will call methods on ListAttributesRequest.Builder
to create a request.default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)
Returns a list of existing clusters.
listClustersRequest
- default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns a list of existing clusters.
This is a convenience which creates an instance of the ListClustersRequest.Builder
avoiding the need to
create one manually via ListClustersRequest.builder()
listClustersRequest
- A Consumer
that will call methods on ListClustersRequest.Builder
to create a request.default CompletableFuture<ListClustersResponse> listClusters()
Returns a list of existing clusters.
default ListClustersPublisher listClustersPaginator()
Returns a list of existing clusters.
This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.
default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest)
Returns a list of existing clusters.
This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.
listClustersRequest
- default ListClustersPublisher listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns a list of existing clusters.
This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.
This is a convenience which creates an instance of the ListClustersRequest.Builder
avoiding the need to
create one manually via ListClustersRequest.builder()
listClustersRequest
- A Consumer
that will call methods on ListClustersRequest.Builder
to create a request.default CompletableFuture<ListContainerInstancesResponse> listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest)
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 EC2 Container Service Developer Guide.
listContainerInstancesRequest
- default CompletableFuture<ListContainerInstancesResponse> listContainerInstances(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest)
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 EC2 Container Service Developer Guide.
This is a convenience which creates an instance of the ListContainerInstancesRequest.Builder
avoiding the
need to create one manually via ListContainerInstancesRequest.builder()
listContainerInstancesRequest
- A Consumer
that will call methods on ListContainerInstancesRequest.Builder
to create a
request.default CompletableFuture<ListContainerInstancesResponse> listContainerInstances()
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 EC2 Container Service Developer Guide.
default ListContainerInstancesPublisher listContainerInstancesPaginator()
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 EC2 Container Service Developer Guide.
This is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.
default ListContainerInstancesPublisher listContainerInstancesPaginator(ListContainerInstancesRequest listContainerInstancesRequest)
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 EC2 Container Service Developer Guide.
This is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.
listContainerInstancesRequest
- default ListContainerInstancesPublisher listContainerInstancesPaginator(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest)
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 EC2 Container Service Developer Guide.
This is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.
This is a convenience which creates an instance of the ListContainerInstancesRequest.Builder
avoiding the
need to create one manually via ListContainerInstancesRequest.builder()
listContainerInstancesRequest
- A Consumer
that will call methods on ListContainerInstancesRequest.Builder
to create a
request.default CompletableFuture<ListServicesResponse> listServices(ListServicesRequest listServicesRequest)
Lists the services that are running in a specified cluster.
listServicesRequest
- default CompletableFuture<ListServicesResponse> listServices(Consumer<ListServicesRequest.Builder> listServicesRequest)
Lists the services that are running in a specified cluster.
This is a convenience which creates an instance of the ListServicesRequest.Builder
avoiding the need to
create one manually via ListServicesRequest.builder()
listServicesRequest
- A Consumer
that will call methods on ListServicesRequest.Builder
to create a request.default CompletableFuture<ListServicesResponse> listServices()
Lists the services that are running in a specified cluster.
default ListServicesPublisher listServicesPaginator()
Lists the services that are running in a specified cluster.
This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListServicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListServicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.
default ListServicesPublisher listServicesPaginator(ListServicesRequest listServicesRequest)
Lists the services that are running in a specified cluster.
This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListServicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListServicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.
listServicesRequest
- default ListServicesPublisher listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)
Lists the services that are running in a specified cluster.
This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListServicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListServicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.
This is a convenience which creates an instance of the ListServicesRequest.Builder
avoiding the need to
create one manually via ListServicesRequest.builder()
listServicesRequest
- A Consumer
that will call methods on ListServicesRequest.Builder
to create a request.default CompletableFuture<ListTaskDefinitionFamiliesResponse> listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest)
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.
listTaskDefinitionFamiliesRequest
- default CompletableFuture<ListTaskDefinitionFamiliesResponse> listTaskDefinitionFamilies(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest)
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.
This is a convenience which creates an instance of the ListTaskDefinitionFamiliesRequest.Builder
avoiding
the need to create one manually via ListTaskDefinitionFamiliesRequest.builder()
listTaskDefinitionFamiliesRequest
- A Consumer
that will call methods on ListTaskDefinitionFamiliesRequest.Builder
to create a
request.default CompletableFuture<ListTaskDefinitionFamiliesResponse> listTaskDefinitionFamilies()
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.
default ListTaskDefinitionFamiliesPublisher listTaskDefinitionFamiliesPaginator()
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.
This is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.
default ListTaskDefinitionFamiliesPublisher listTaskDefinitionFamiliesPaginator(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest)
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.
This is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.
listTaskDefinitionFamiliesRequest
- default ListTaskDefinitionFamiliesPublisher listTaskDefinitionFamiliesPaginator(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest)
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.
This is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.
This is a convenience which creates an instance of the ListTaskDefinitionFamiliesRequest.Builder
avoiding
the need to create one manually via ListTaskDefinitionFamiliesRequest.builder()
listTaskDefinitionFamiliesRequest
- A Consumer
that will call methods on ListTaskDefinitionFamiliesRequest.Builder
to create a
request.default CompletableFuture<ListTaskDefinitionsResponse> listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest)
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.
listTaskDefinitionsRequest
- default CompletableFuture<ListTaskDefinitionsResponse> listTaskDefinitions(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest)
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.
This is a convenience which creates an instance of the ListTaskDefinitionsRequest.Builder
avoiding the
need to create one manually via ListTaskDefinitionsRequest.builder()
listTaskDefinitionsRequest
- A Consumer
that will call methods on ListTaskDefinitionsRequest.Builder
to create a
request.default CompletableFuture<ListTaskDefinitionsResponse> listTaskDefinitions()
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.
default ListTaskDefinitionsPublisher listTaskDefinitionsPaginator()
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.
This is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.
default ListTaskDefinitionsPublisher listTaskDefinitionsPaginator(ListTaskDefinitionsRequest listTaskDefinitionsRequest)
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.
This is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.
listTaskDefinitionsRequest
- default ListTaskDefinitionsPublisher listTaskDefinitionsPaginator(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest)
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.
This is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.
This is a convenience which creates an instance of the ListTaskDefinitionsRequest.Builder
avoiding the
need to create one manually via ListTaskDefinitionsRequest.builder()
listTaskDefinitionsRequest
- A Consumer
that will call methods on ListTaskDefinitionsRequest.Builder
to create a
request.default CompletableFuture<ListTasksResponse> listTasks(ListTasksRequest listTasksRequest)
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.
listTasksRequest
- default CompletableFuture<ListTasksResponse> listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
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.
This is a convenience which creates an instance of the ListTasksRequest.Builder
avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest
- A Consumer
that will call methods on ListTasksRequest.Builder
to create a request.default CompletableFuture<ListTasksResponse> listTasks()
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.
default ListTasksPublisher listTasksPaginator()
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.
This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
default ListTasksPublisher listTasksPaginator(ListTasksRequest listTasksRequest)
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.
This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
listTasksRequest
- default ListTasksPublisher listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
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.
This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ecs.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
This is a convenience which creates an instance of the ListTasksRequest.Builder
avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest
- A Consumer
that will call methods on ListTasksRequest.Builder
to create a request.default CompletableFuture<PutAttributesResponse> putAttributes(PutAttributesRequest putAttributesRequest)
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 EC2 Container Service Developer Guide.
putAttributesRequest
- default CompletableFuture<PutAttributesResponse> putAttributes(Consumer<PutAttributesRequest.Builder> putAttributesRequest)
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 EC2 Container Service Developer Guide.
This is a convenience which creates an instance of the PutAttributesRequest.Builder
avoiding the need to
create one manually via PutAttributesRequest.builder()
putAttributesRequest
- A Consumer
that will call methods on PutAttributesRequest.Builder
to create a request.default CompletableFuture<RegisterContainerInstanceResponse> registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest)
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.
registerContainerInstanceRequest
- default CompletableFuture<RegisterContainerInstanceResponse> registerContainerInstance(Consumer<RegisterContainerInstanceRequest.Builder> registerContainerInstanceRequest)
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.
This is a convenience which creates an instance of the RegisterContainerInstanceRequest.Builder
avoiding
the need to create one manually via RegisterContainerInstanceRequest.builder()
registerContainerInstanceRequest
- A Consumer
that will call methods on RegisterContainerInstanceRequest.Builder
to create a
request.default CompletableFuture<RegisterTaskDefinitionResponse> registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest)
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.
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 EC2 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.
registerTaskDefinitionRequest
- default CompletableFuture<RegisterTaskDefinitionResponse> registerTaskDefinition(Consumer<RegisterTaskDefinitionRequest.Builder> registerTaskDefinitionRequest)
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.
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 EC2 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.
This is a convenience which creates an instance of the RegisterTaskDefinitionRequest.Builder
avoiding the
need to create one manually via RegisterTaskDefinitionRequest.builder()
registerTaskDefinitionRequest
- A Consumer
that will call methods on RegisterTaskDefinitionRequest.Builder
to create a
request.default CompletableFuture<RunTaskResponse> runTask(RunTaskRequest runTaskRequest)
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 EC2 Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
runTaskRequest
- default CompletableFuture<RunTaskResponse> runTask(Consumer<RunTaskRequest.Builder> runTaskRequest)
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 EC2 Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
This is a convenience which creates an instance of the RunTaskRequest.Builder
avoiding the need to create
one manually via RunTaskRequest.builder()
runTaskRequest
- A Consumer
that will call methods on RunTaskRequest.Builder
to create a request.default CompletableFuture<StartTaskResponse> startTask(StartTaskRequest startTaskRequest)
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 EC2 Container Service Developer Guide.
startTaskRequest
- default CompletableFuture<StartTaskResponse> startTask(Consumer<StartTaskRequest.Builder> startTaskRequest)
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 EC2 Container Service Developer Guide.
This is a convenience which creates an instance of the StartTaskRequest.Builder
avoiding the need to
create one manually via StartTaskRequest.builder()
startTaskRequest
- A Consumer
that will call methods on StartTaskRequest.Builder
to create a request.default CompletableFuture<StopTaskResponse> stopTask(StopTaskRequest stopTaskRequest)
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 default 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.
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 EC2 Container Service Developer Guide.
stopTaskRequest
- default CompletableFuture<StopTaskResponse> stopTask(Consumer<StopTaskRequest.Builder> stopTaskRequest)
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 default 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.
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 EC2 Container Service Developer Guide.
This is a convenience which creates an instance of the StopTaskRequest.Builder
avoiding the need to
create one manually via StopTaskRequest.builder()
stopTaskRequest
- A Consumer
that will call methods on StopTaskRequest.Builder
to create a request.default CompletableFuture<SubmitContainerStateChangeResponse> submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest)
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.
submitContainerStateChangeRequest
- default CompletableFuture<SubmitContainerStateChangeResponse> submitContainerStateChange(Consumer<SubmitContainerStateChangeRequest.Builder> submitContainerStateChangeRequest)
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.
This is a convenience which creates an instance of the SubmitContainerStateChangeRequest.Builder
avoiding
the need to create one manually via SubmitContainerStateChangeRequest.builder()
submitContainerStateChangeRequest
- A Consumer
that will call methods on SubmitContainerStateChangeRequest.Builder
to create a
request.default CompletableFuture<SubmitTaskStateChangeResponse> submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest)
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.
submitTaskStateChangeRequest
- default CompletableFuture<SubmitTaskStateChangeResponse> submitTaskStateChange(Consumer<SubmitTaskStateChangeRequest.Builder> submitTaskStateChangeRequest)
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.
This is a convenience which creates an instance of the SubmitTaskStateChangeRequest.Builder
avoiding the
need to create one manually via SubmitTaskStateChangeRequest.builder()
submitTaskStateChangeRequest
- A Consumer
that will call methods on SubmitTaskStateChangeRequest.Builder
to create a
request.default CompletableFuture<UpdateContainerAgentResponse> updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest)
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.
updateContainerAgentRequest
- PENDING
or STAGING
, the update process can get
stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.default CompletableFuture<UpdateContainerAgentResponse> updateContainerAgent(Consumer<UpdateContainerAgentRequest.Builder> updateContainerAgentRequest)
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.
This is a convenience which creates an instance of the UpdateContainerAgentRequest.Builder
avoiding the
need to create one manually via UpdateContainerAgentRequest.builder()
updateContainerAgentRequest
- A Consumer
that will call methods on UpdateContainerAgentRequest.Builder
to create a
request.PENDING
or STAGING
, the update process can get
stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.default CompletableFuture<UpdateContainerInstancesStateResponse> updateContainerInstancesState(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest)
Modifies the status of an Amazon ECS container instance.
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.
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 the service's deployment configuration parameters, minimumHealthyPercent
and
maximumPercent
. Note that 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
of
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 you set a container instance to ACTIVE
, the Amazon ECS scheduler can begin scheduling tasks on
the instance again.
updateContainerInstancesStateRequest
- default CompletableFuture<UpdateContainerInstancesStateResponse> updateContainerInstancesState(Consumer<UpdateContainerInstancesStateRequest.Builder> updateContainerInstancesStateRequest)
Modifies the status of an Amazon ECS container instance.
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.
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 the service's deployment configuration parameters, minimumHealthyPercent
and
maximumPercent
. Note that 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
of
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 you set a container instance to ACTIVE
, the Amazon ECS scheduler can begin scheduling tasks on
the instance again.
This is a convenience which creates an instance of the UpdateContainerInstancesStateRequest.Builder
avoiding the need to create one manually via UpdateContainerInstancesStateRequest.builder()
updateContainerInstancesStateRequest
- A Consumer
that will call methods on UpdateContainerInstancesStateRequest.Builder
to
create a request.default CompletableFuture<UpdateServiceResponse> updateService(UpdateServiceRequest updateServiceRequest)
Modifies the desired count, deployment configuration, network 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 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.
updateServiceRequest
- default CompletableFuture<UpdateServiceResponse> updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest)
Modifies the desired count, deployment configuration, network 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 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.
This is a convenience which creates an instance of the UpdateServiceRequest.Builder
avoiding the need to
create one manually via UpdateServiceRequest.builder()
updateServiceRequest
- A Consumer
that will call methods on UpdateServiceRequest.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.