software.amazon.awssdk.services.ecs.model

Interface UpdateServiceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>, EcsRequest.Builder, SdkBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateServiceRequest

public static interface UpdateServiceRequest.Builder
extends EcsRequest.Builder, SdkPojo, CopyableBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>

Method Summary

Modifier and Type	Method and Description
UpdateServiceRequest.Builder	capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy) The capacity provider strategy to update the service to use.
UpdateServiceRequest.Builder	capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy to update the service to use.
UpdateServiceRequest.Builder	capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy) The capacity provider strategy to update the service to use.
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	enableExecuteCommand(Boolean enableExecuteCommand) If true, this enables execute command functionality on all task containers.
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) An object representing the network configuration for the service.
UpdateServiceRequest.Builder	networkConfiguration(NetworkConfiguration networkConfiguration) An object representing the network configuration for the service.
UpdateServiceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateServiceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateServiceRequest.Builder	placementConstraints(Collection<PlacementConstraint> placementConstraints) An array of task placement constraint objects to update the service to use.
UpdateServiceRequest.Builder	placementConstraints(Consumer<PlacementConstraint.Builder>... placementConstraints) An array of task placement constraint objects to update the service to use.
UpdateServiceRequest.Builder	placementConstraints(PlacementConstraint... placementConstraints) An array of task placement constraint objects to update the service to use.
UpdateServiceRequest.Builder	placementStrategy(Collection<PlacementStrategy> placementStrategy) The task placement strategy objects to update the service to use.
UpdateServiceRequest.Builder	placementStrategy(Consumer<PlacementStrategy.Builder>... placementStrategy) The task placement strategy objects to update the service to use.
UpdateServiceRequest.Builder	placementStrategy(PlacementStrategy... placementStrategy) The task placement strategy objects to update the service to use.
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.

Methods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

cluster

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

service

UpdateServiceRequest.Builder service(String service)

The name of the service to update.

Parameters:

service - The name of the service to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

desiredCount

UpdateServiceRequest.Builder desiredCount(Integer desiredCount)

The number of instantiations of the task to place and keep running in your service.

Parameters:

desiredCount - The number of instantiations of the task to place and keep running in your service.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskDefinition

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityProviderStrategy

UpdateServiceRequest.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Parameters:

capacityProviderStrategy - The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityProviderStrategy

UpdateServiceRequest.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)

The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Parameters:

capacityProviderStrategy - The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityProviderStrategy

UpdateServiceRequest.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)

The capacity provider strategy to update the service to use.

If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #capacityProviderStrategy(List).

Parameters:

capacityProviderStrategy - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#capacityProviderStrategy(List)

deploymentConfiguration

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.

Parameters:

deploymentConfiguration - Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Returns:

Returns a reference to this object so that method calls can be chained together.

deploymentConfiguration

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 the DeploymentConfiguration.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).

Parameters:

deploymentConfiguration - a consumer that will call methods on DeploymentConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

deploymentConfiguration(DeploymentConfiguration)

networkConfiguration

UpdateServiceRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

An object representing the network configuration for the service.

Parameters:

networkConfiguration - An object representing the network configuration for the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkConfiguration

default UpdateServiceRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)

An object representing the network configuration for the service.

This is a convenience that creates an instance of the 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).

Parameters:

networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

networkConfiguration(NetworkConfiguration)

placementConstraints

UpdateServiceRequest.Builder placementConstraints(Collection<PlacementConstraint> placementConstraints)

An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Parameters:

placementConstraints - An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Returns:

Returns a reference to this object so that method calls can be chained together.

placementConstraints

UpdateServiceRequest.Builder placementConstraints(PlacementConstraint... placementConstraints)

An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Parameters:

placementConstraints - An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

Returns:

Returns a reference to this object so that method calls can be chained together.

placementConstraints

UpdateServiceRequest.Builder placementConstraints(Consumer<PlacementConstraint.Builder>... placementConstraints)

An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #placementConstraints(List).

Parameters:

placementConstraints - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#placementConstraints(List)

placementStrategy

UpdateServiceRequest.Builder placementStrategy(Collection<PlacementStrategy> placementStrategy)

The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules per service.

Parameters:

placementStrategy - The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules per service.

Returns:

Returns a reference to this object so that method calls can be chained together.

placementStrategy

UpdateServiceRequest.Builder placementStrategy(PlacementStrategy... placementStrategy)

The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules per service.

Parameters:

placementStrategy - The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules per service.

Returns:

Returns a reference to this object so that method calls can be chained together.

placementStrategy

UpdateServiceRequest.Builder placementStrategy(Consumer<PlacementStrategy.Builder>... placementStrategy)

The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules per service.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #placementStrategy(List).

Parameters:

placementStrategy - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#placementStrategy(List)

platformVersion

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 a platform version 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.

Parameters:

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 a platform version 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

forceNewDeployment

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

healthCheckGracePeriodSeconds

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 2,147,483,647 seconds. During that time, the Amazon 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.

Parameters:

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 2,147,483,647 seconds. During that time, the Amazon 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableExecuteCommand

UpdateServiceRequest.Builder enableExecuteCommand(Boolean enableExecuteCommand)

If true, this enables execute command functionality on all task containers.

If you do not want to override the value that was set when the service was created, you can set this to null when performing this action.

Parameters:

enableExecuteCommand - If true, this enables execute command functionality on all task containers.

If you do not want to override the value that was set when the service was created, you can set this to null when performing this action.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder