Interface UpdateServiceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>, EcsRequest.Builder, SdkBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateServiceRequest
@Mutable @NotThreadSafe public static interface UpdateServiceRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<UpdateServiceRequest.Builder,UpdateServiceRequest>

  • Method Details

    • cluster

      UpdateServiceRequest.Builder cluster(String cluster)

      The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on. If you do not specify a cluster, the default cluster is assumed.

      You can't change the cluster name.

      Parameters:
      cluster - The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on. If you do not specify a cluster, the default cluster is assumed.

      You can't change the cluster name.

      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 details of a capacity provider strategy. You can set a capacity provider when you create a cluster, run a task, or update a service.

      When you use Fargate, the capacity providers are FARGATE or FARGATE_SPOT.

      When you use Amazon EC2, the capacity providers are Auto Scaling groups.

      You can change capacity providers for rolling deployments and blue/green deployments.

      The following list provides the valid transitions:

      • Update the Fargate launch type to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 launch type to a Fargate capacity provider.

      • Update the Fargate capacity provider to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 capacity provider to a Fargate capacity provider.

      • Update the Auto Scaling group or Fargate capacity provider back to the launch type.

        Pass an empty list in the capacityProviderStrategy parameter.

      For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.

      Parameters:
      capacityProviderStrategy - The details of a capacity provider strategy. You can set a capacity provider when you create a cluster, run a task, or update a service.

      When you use Fargate, the capacity providers are FARGATE or FARGATE_SPOT.

      When you use Amazon EC2, the capacity providers are Auto Scaling groups.

      You can change capacity providers for rolling deployments and blue/green deployments.

      The following list provides the valid transitions:

      • Update the Fargate launch type to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 launch type to a Fargate capacity provider.

      • Update the Fargate capacity provider to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 capacity provider to a Fargate capacity provider.

      • Update the Auto Scaling group or Fargate capacity provider back to the launch type.

        Pass an empty list in the capacityProviderStrategy parameter.

      For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.

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

    • capacityProviderStrategy

      UpdateServiceRequest.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)

      The details of a capacity provider strategy. You can set a capacity provider when you create a cluster, run a task, or update a service.

      When you use Fargate, the capacity providers are FARGATE or FARGATE_SPOT.

      When you use Amazon EC2, the capacity providers are Auto Scaling groups.

      You can change capacity providers for rolling deployments and blue/green deployments.

      The following list provides the valid transitions:

      • Update the Fargate launch type to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 launch type to a Fargate capacity provider.

      • Update the Fargate capacity provider to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 capacity provider to a Fargate capacity provider.

      • Update the Auto Scaling group or Fargate capacity provider back to the launch type.

        Pass an empty list in the capacityProviderStrategy parameter.

      For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.

      Parameters:
      capacityProviderStrategy - The details of a capacity provider strategy. You can set a capacity provider when you create a cluster, run a task, or update a service.

      When you use Fargate, the capacity providers are FARGATE or FARGATE_SPOT.

      When you use Amazon EC2, the capacity providers are Auto Scaling groups.

      You can change capacity providers for rolling deployments and blue/green deployments.

      The following list provides the valid transitions:

      • Update the Fargate launch type to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 launch type to a Fargate capacity provider.

      • Update the Fargate capacity provider to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 capacity provider to a Fargate capacity provider.

      • Update the Auto Scaling group or Fargate capacity provider back to the launch type.

        Pass an empty list in the capacityProviderStrategy parameter.

      For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.

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

    • capacityProviderStrategy

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

      The details of a capacity provider strategy. You can set a capacity provider when you create a cluster, run a task, or update a service.

      When you use Fargate, the capacity providers are FARGATE or FARGATE_SPOT.

      When you use Amazon EC2, the capacity providers are Auto Scaling groups.

      You can change capacity providers for rolling deployments and blue/green deployments.

      The following list provides the valid transitions:

      • Update the Fargate launch type to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 launch type to a Fargate capacity provider.

      • Update the Fargate capacity provider to an Auto Scaling group capacity provider.

      • Update the Amazon EC2 capacity provider to a Fargate capacity provider.

      • Update the Auto Scaling group or Fargate capacity provider back to the launch type.

        Pass an empty list in the capacityProviderStrategy parameter.

      For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.

      This is a convenience method that creates an instance of the CapacityProviderStrategyItem.Builder avoiding the need to create one manually via CapacityProviderStrategyItem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityProviderStrategy(List<CapacityProviderStrategyItem>).

      Parameters:
      capacityProviderStrategy - a consumer that will call methods on CapacityProviderStrategyItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 method 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:

    • availabilityZoneRebalancing

      UpdateServiceRequest.Builder availabilityZoneRebalancing(String availabilityZoneRebalancing)

      Indicates whether to use Availability Zone rebalancing for the service.

      For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .

      Parameters:
      availabilityZoneRebalancing - Indicates whether to use Availability Zone rebalancing for the service.

      For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .

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

    • availabilityZoneRebalancing

      UpdateServiceRequest.Builder availabilityZoneRebalancing(AvailabilityZoneRebalancing availabilityZoneRebalancing)

      Indicates whether to use Availability Zone rebalancing for the service.

      For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .

      Parameters:
      availabilityZoneRebalancing - Indicates whether to use Availability Zone rebalancing for the service.

      For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .

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

    • 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 method 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:

    • 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 for each 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 for each 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 for each 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 for each 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 for each task. This limit includes constraints in the task definition and those specified at runtime.

      This is a convenience method that creates an instance of the PlacementConstraint.Builder avoiding the need to create one manually via PlacementConstraint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placementConstraints(List<PlacementConstraint>).

      Parameters:
      placementConstraints - a consumer that will call methods on PlacementConstraint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 for each 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 for each 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 for each 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 for each 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 for each service.

      This is a convenience method that creates an instance of the PlacementStrategy.Builder avoiding the need to create one manually via PlacementStrategy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placementStrategy(List<PlacementStrategy>).

      Parameters:
      placementStrategy - a consumer that will call methods on PlacementStrategy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platformVersion

      UpdateServiceRequest.Builder platformVersion(String platformVersion)

      The platform version that your tasks in the service run on. 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. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      platformVersion - The platform version that your tasks in the service run on. 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. For more information, see 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)

      Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start 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 - Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start 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 ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.

      If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the 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 ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.

      If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the 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.

    • deploymentController

      UpdateServiceRequest.Builder deploymentController(DeploymentController deploymentController)
      Sets the value of the DeploymentController property for this object.
      Parameters:
      deploymentController - The new value for the DeploymentController property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentController

      default UpdateServiceRequest.Builder deploymentController(Consumer<DeploymentController.Builder> deploymentController)
      Sets the value of the DeploymentController property for this object. This is a convenience method that creates an instance of the DeploymentController.Builder avoiding the need to create one manually via DeploymentController.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentController(DeploymentController).

      Parameters:
      deploymentController - a consumer that will call methods on DeploymentController.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • enableECSManagedTags

      UpdateServiceRequest.Builder enableECSManagedTags(Boolean enableECSManagedTags)

      Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

      Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

      Parameters:
      enableECSManagedTags - Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

      Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

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

    • loadBalancers

      UpdateServiceRequest.Builder loadBalancers(Collection<LoadBalancer> loadBalancers)

      You must have a service-linked role when you update this property

      A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

      When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

      For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

      For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      You can remove existing loadBalancers by passing an empty list.

      Parameters:
      loadBalancers -

      You must have a service-linked role when you update this property

      A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

      When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

      For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

      For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      You can remove existing loadBalancers by passing an empty list.

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

    • loadBalancers

      UpdateServiceRequest.Builder loadBalancers(LoadBalancer... loadBalancers)

      You must have a service-linked role when you update this property

      A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

      When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

      For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

      For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      You can remove existing loadBalancers by passing an empty list.

      Parameters:
      loadBalancers -

      You must have a service-linked role when you update this property

      A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

      When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

      For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

      For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      You can remove existing loadBalancers by passing an empty list.

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

    • loadBalancers

      UpdateServiceRequest.Builder loadBalancers(Consumer<LoadBalancer.Builder>... loadBalancers)

      You must have a service-linked role when you update this property

      A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

      When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

      For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

      For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

      You can remove existing loadBalancers by passing an empty list.

      This is a convenience method that creates an instance of the LoadBalancer.Builder avoiding the need to create one manually via LoadBalancer.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loadBalancers(List<LoadBalancer>).

      Parameters:
      loadBalancers - a consumer that will call methods on LoadBalancer.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propagateTags

      UpdateServiceRequest.Builder propagateTags(String propagateTags)

      Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

      Parameters:
      propagateTags - Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

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

    • propagateTags

      UpdateServiceRequest.Builder propagateTags(PropagateTags propagateTags)

      Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

      Parameters:
      propagateTags - Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

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

    • serviceRegistries

      UpdateServiceRequest.Builder serviceRegistries(Collection<ServiceRegistry> serviceRegistries)

      You must have a service-linked role when you update this property.

      For more information about the role see the CreateService request parameter role .

      The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

      When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

      You can remove existing serviceRegistries by passing an empty list.

      Parameters:
      serviceRegistries -

      You must have a service-linked role when you update this property.

      For more information about the role see the CreateService request parameter role .

      The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

      When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

      You can remove existing serviceRegistries by passing an empty list.

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

    • serviceRegistries

      UpdateServiceRequest.Builder serviceRegistries(ServiceRegistry... serviceRegistries)

      You must have a service-linked role when you update this property.

      For more information about the role see the CreateService request parameter role .

      The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

      When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

      You can remove existing serviceRegistries by passing an empty list.

      Parameters:
      serviceRegistries -

      You must have a service-linked role when you update this property.

      For more information about the role see the CreateService request parameter role .

      The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

      When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

      You can remove existing serviceRegistries by passing an empty list.

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

    • serviceRegistries

      UpdateServiceRequest.Builder serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)

      You must have a service-linked role when you update this property.

      For more information about the role see the CreateService request parameter role .

      The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

      When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

      You can remove existing serviceRegistries by passing an empty list.

      This is a convenience method that creates an instance of the ServiceRegistry.Builder avoiding the need to create one manually via ServiceRegistry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceRegistries(List<ServiceRegistry>).

      Parameters:
      serviceRegistries - a consumer that will call methods on ServiceRegistry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serviceConnectConfiguration

      UpdateServiceRequest.Builder serviceConnectConfiguration(ServiceConnectConfiguration serviceConnectConfiguration)

      The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      serviceConnectConfiguration - The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

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

    • serviceConnectConfiguration

      default UpdateServiceRequest.Builder serviceConnectConfiguration(Consumer<ServiceConnectConfiguration.Builder> serviceConnectConfiguration)

      The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

      Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

      This is a convenience method that creates an instance of the ServiceConnectConfiguration.Builder avoiding the need to create one manually via ServiceConnectConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceConnectConfiguration(ServiceConnectConfiguration).

      Parameters:
      serviceConnectConfiguration - a consumer that will call methods on ServiceConnectConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • volumeConfigurations

      UpdateServiceRequest.Builder volumeConfigurations(Collection<ServiceVolumeConfiguration> volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.

      Parameters:
      volumeConfigurations - The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      UpdateServiceRequest.Builder volumeConfigurations(ServiceVolumeConfiguration... volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.

      Parameters:
      volumeConfigurations - The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      UpdateServiceRequest.Builder volumeConfigurations(Consumer<ServiceVolumeConfiguration.Builder>... volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.

      This is a convenience method that creates an instance of the ServiceVolumeConfiguration.Builder avoiding the need to create one manually via ServiceVolumeConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to volumeConfigurations(List<ServiceVolumeConfiguration>).

      Parameters:
      volumeConfigurations - a consumer that will call methods on ServiceVolumeConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcLatticeConfigurations

      UpdateServiceRequest.Builder vpcLatticeConfigurations(Collection<VpcLatticeConfiguration> vpcLatticeConfigurations)

      An object representing the VPC Lattice configuration for the service being updated.

      Parameters:
      vpcLatticeConfigurations - An object representing the VPC Lattice configuration for the service being updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcLatticeConfigurations

      UpdateServiceRequest.Builder vpcLatticeConfigurations(VpcLatticeConfiguration... vpcLatticeConfigurations)

      An object representing the VPC Lattice configuration for the service being updated.

      Parameters:
      vpcLatticeConfigurations - An object representing the VPC Lattice configuration for the service being updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcLatticeConfigurations

      UpdateServiceRequest.Builder vpcLatticeConfigurations(Consumer<VpcLatticeConfiguration.Builder>... vpcLatticeConfigurations)

      An object representing the VPC Lattice configuration for the service being updated.

      This is a convenience method that creates an instance of the VpcLatticeConfiguration.Builder avoiding the need to create one manually via VpcLatticeConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcLatticeConfigurations(List<VpcLatticeConfiguration>).

      Parameters:
      vpcLatticeConfigurations - a consumer that will call methods on VpcLatticeConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.