public static interface UpdateServiceRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>
| Modifier and Type | Method and Description |
|---|---|
UpdateServiceRequest.Builder |
cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.
|
default UpdateServiceRequest.Builder |
deploymentConfiguration(Consumer<DeploymentConfiguration.Builder> deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of
stopping and starting tasks.
|
UpdateServiceRequest.Builder |
deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of
stopping and starting tasks.
|
UpdateServiceRequest.Builder |
desiredCount(Integer desiredCount)
The number of instantiations of the task to place and keep running in your service.
|
UpdateServiceRequest.Builder |
forceNewDeployment(Boolean forceNewDeployment)
Whether to force a new deployment of the service.
|
UpdateServiceRequest.Builder |
healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load
Balancing target health checks after a task has first started.
|
default UpdateServiceRequest.Builder |
networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The network configuration for the service.
|
UpdateServiceRequest.Builder |
networkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the service.
|
UpdateServiceRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
UpdateServiceRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
UpdateServiceRequest.Builder |
platformVersion(String platformVersion)
The platform version on which your tasks in the service are running.
|
UpdateServiceRequest.Builder |
service(String service)
The name of the service to update.
|
UpdateServiceRequest.Builder |
taskDefinition(String taskDefinition)
The
family and revision (family:revision) or full ARN of the task
definition to run in your service. |
buildoverrideConfigurationcopyapplyMutation, buildUpdateServiceRequest.Builder cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
cluster - The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If
you do not specify a cluster, the default cluster is assumed.UpdateServiceRequest.Builder service(String service)
The name of the service to update.
service - The name of the service to update.UpdateServiceRequest.Builder desiredCount(Integer desiredCount)
The number of instantiations of the task to place and keep running in your service.
desiredCount - The number of instantiations of the task to place and keep running in your service.UpdateServiceRequest.Builder taskDefinition(String taskDefinition)
The family and revision (family:revision) or full ARN of the task
definition to run in your service. If a revision is not specified, the latest
ACTIVE revision is used. If you modify the task definition with UpdateService,
Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new
version is running.
taskDefinition - The family and revision (family:revision) or full ARN of the
task definition to run in your service. If a revision is not specified, the latest
ACTIVE revision is used. If you modify the task definition with
UpdateService, Amazon ECS spawns a task with the new version of the task definition and
then stops an old task after the new version is running.UpdateServiceRequest.Builder deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentConfiguration - Optional deployment parameters that control how many tasks run during the deployment and the ordering
of stopping and starting tasks.default UpdateServiceRequest.Builder deploymentConfiguration(Consumer<DeploymentConfiguration.Builder> deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
This is a convenience that creates an instance of theDeploymentConfiguration.Builder avoiding the
need to create one manually via DeploymentConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to deploymentConfiguration(DeploymentConfiguration).deploymentConfiguration - a consumer that will call methods on DeploymentConfiguration.BuilderdeploymentConfiguration(DeploymentConfiguration)UpdateServiceRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the service. This parameter is required for task definitions that use the
awsvpc network mode to receive their own elastic network interface, and it is not supported for
other network modes. For more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.
networkConfiguration - The network configuration for the service. This parameter is required for task definitions that use
the awsvpc network mode to receive their own elastic network interface, and it is not
supported for other network modes. For more information, see Task
Networking in the Amazon Elastic Container Service Developer Guide. Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.
default UpdateServiceRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The network configuration for the service. This parameter is required for task definitions that use the
awsvpc network mode to receive their own elastic network interface, and it is not supported for
other network modes. For more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.
NetworkConfiguration.Builder avoiding
the need to create one manually via NetworkConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to networkConfiguration(NetworkConfiguration).networkConfiguration - a consumer that will call methods on NetworkConfiguration.BuildernetworkConfiguration(NetworkConfiguration)UpdateServiceRequest.Builder platformVersion(String platformVersion)
The platform version on which your tasks in the service are running. A platform version is only specified for
tasks using the Fargate launch type. If one is not specified, the LATEST platform version is
used by default. For more information, see AWS Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
platformVersion - The platform version on which your tasks in the service are running. A platform version is only
specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.UpdateServiceRequest.Builder forceNewDeployment(Boolean forceNewDeployment)
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this
option to trigger a new deployment with no service definition changes. For example, you can update a
service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest
) or to roll Fargate tasks onto a newer platform version.
forceNewDeployment - Whether to force a new deployment of the service. Deployments are not forced by default. You can use
this option to trigger a new deployment with no service definition changes. For example, you can
update a service's tasks to use a newer Docker image with the same image/tag combination (
my_image:latest) or to roll Fargate tasks onto a newer platform version.UpdateServiceRequest.Builder healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
healthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic
Load Balancing target health checks after a task has first started. This is only valid if your service
is configured to use a load balancer. If your service's tasks take a while to start and respond to
Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800
seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check
status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and
stopping them before they have time to come up.UpdateServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.UpdateServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.