pub struct UpdateServiceFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateService
.
Modifies the parameters of a service.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
For services using the rolling update (ECS
) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment. volumeConfigurations
is only supported for REPLICA service and not DAEMON service. If you leave volumeConfigurations
null
, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
For services using the blue/green (CODE_DEPLOY
) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.
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 attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
If you have updated the container image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest
), you don't need to create a new revision of your task definition. You can update the service using the forceNewDeployment
option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
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 ignoredesiredCount
temporarily during a deployment. For example, ifdesiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in theRUNNING
state and are reported as healthy by the load balancer. -
The
maximumPercent
parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, ifdesiredCount
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 this, 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 even though 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.
Implementations§
Source§impl UpdateServiceFluentBuilder
impl UpdateServiceFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateServiceInputBuilder
pub fn as_input(&self) -> &UpdateServiceInputBuilder
Access the UpdateService as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateServiceOutput, SdkError<UpdateServiceError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateServiceOutput, SdkError<UpdateServiceError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateServiceOutput, UpdateServiceError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateServiceOutput, UpdateServiceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn cluster(self, input: impl Into<String>) -> Self
pub fn cluster(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_cluster(self, input: Option<String>) -> Self
pub fn set_cluster(self, input: Option<String>) -> Self
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.
Sourcepub fn get_cluster(&self) -> &Option<String>
pub fn get_cluster(&self) -> &Option<String>
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.
Sourcepub fn set_service(self, input: Option<String>) -> Self
pub fn set_service(self, input: Option<String>) -> Self
The name of the service to update.
Sourcepub fn get_service(&self) -> &Option<String>
pub fn get_service(&self) -> &Option<String>
The name of the service to update.
Sourcepub fn desired_count(self, input: i32) -> Self
pub fn desired_count(self, input: i32) -> Self
The number of instantiations of the task to place and keep running in your service.
Sourcepub fn set_desired_count(self, input: Option<i32>) -> Self
pub fn set_desired_count(self, input: Option<i32>) -> Self
The number of instantiations of the task to place and keep running in your service.
Sourcepub fn get_desired_count(&self) -> &Option<i32>
pub fn get_desired_count(&self) -> &Option<i32>
The number of instantiations of the task to place and keep running in your service.
Sourcepub fn task_definition(self, input: impl Into<String>) -> Self
pub fn task_definition(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_task_definition(self, input: Option<String>) -> Self
pub fn set_task_definition(self, input: Option<String>) -> Self
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.
Sourcepub fn get_task_definition(&self) -> &Option<String>
pub fn get_task_definition(&self) -> &Option<String>
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.
Sourcepub fn capacity_provider_strategy(
self,
input: CapacityProviderStrategyItem,
) -> Self
pub fn capacity_provider_strategy( self, input: CapacityProviderStrategyItem, ) -> Self
Appends an item to capacityProviderStrategy
.
To override the contents of this collection use set_capacity_provider_strategy
.
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 EC2 capacity provider.
-
Update the Amazon EC2 launch type to a Fargate capacity provider.
-
Update the Fargate capacity provider to an EC2 capacity provider.
-
Update the Amazon EC2 capacity provider to a Fargate capacity provider.
-
Update the EC2 or Fargate capacity provider back to the launch type.
Pass an empty list in the
capacityProvider
parameter.
For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.
Sourcepub fn set_capacity_provider_strategy(
self,
input: Option<Vec<CapacityProviderStrategyItem>>,
) -> Self
pub fn set_capacity_provider_strategy( self, input: Option<Vec<CapacityProviderStrategyItem>>, ) -> Self
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 EC2 capacity provider.
-
Update the Amazon EC2 launch type to a Fargate capacity provider.
-
Update the Fargate capacity provider to an EC2 capacity provider.
-
Update the Amazon EC2 capacity provider to a Fargate capacity provider.
-
Update the EC2 or Fargate capacity provider back to the launch type.
Pass an empty list in the
capacityProvider
parameter.
For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.
Sourcepub fn get_capacity_provider_strategy(
&self,
) -> &Option<Vec<CapacityProviderStrategyItem>>
pub fn get_capacity_provider_strategy( &self, ) -> &Option<Vec<CapacityProviderStrategyItem>>
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 EC2 capacity provider.
-
Update the Amazon EC2 launch type to a Fargate capacity provider.
-
Update the Fargate capacity provider to an EC2 capacity provider.
-
Update the Amazon EC2 capacity provider to a Fargate capacity provider.
-
Update the EC2 or Fargate capacity provider back to the launch type.
Pass an empty list in the
capacityProvider
parameter.
For information about Amazon Web Services CDK considerations, see Amazon Web Services CDK considerations.
Sourcepub fn deployment_configuration(self, input: DeploymentConfiguration) -> Self
pub fn deployment_configuration(self, input: DeploymentConfiguration) -> Self
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Sourcepub fn set_deployment_configuration(
self,
input: Option<DeploymentConfiguration>,
) -> Self
pub fn set_deployment_configuration( self, input: Option<DeploymentConfiguration>, ) -> Self
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Sourcepub fn get_deployment_configuration(&self) -> &Option<DeploymentConfiguration>
pub fn get_deployment_configuration(&self) -> &Option<DeploymentConfiguration>
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Sourcepub fn availability_zone_rebalancing(
self,
input: AvailabilityZoneRebalancing,
) -> Self
pub fn availability_zone_rebalancing( self, input: AvailabilityZoneRebalancing, ) -> Self
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 .
Sourcepub fn set_availability_zone_rebalancing(
self,
input: Option<AvailabilityZoneRebalancing>,
) -> Self
pub fn set_availability_zone_rebalancing( self, input: Option<AvailabilityZoneRebalancing>, ) -> Self
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 .
Sourcepub fn get_availability_zone_rebalancing(
&self,
) -> &Option<AvailabilityZoneRebalancing>
pub fn get_availability_zone_rebalancing( &self, ) -> &Option<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 .
Sourcepub fn network_configuration(self, input: NetworkConfiguration) -> Self
pub fn network_configuration(self, input: NetworkConfiguration) -> Self
An object representing the network configuration for the service.
Sourcepub fn set_network_configuration(
self,
input: Option<NetworkConfiguration>,
) -> Self
pub fn set_network_configuration( self, input: Option<NetworkConfiguration>, ) -> Self
An object representing the network configuration for the service.
Sourcepub fn get_network_configuration(&self) -> &Option<NetworkConfiguration>
pub fn get_network_configuration(&self) -> &Option<NetworkConfiguration>
An object representing the network configuration for the service.
Sourcepub fn placement_constraints(self, input: PlacementConstraint) -> Self
pub fn placement_constraints(self, input: PlacementConstraint) -> Self
Appends an item to placementConstraints
.
To override the contents of this collection use set_placement_constraints
.
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.
Sourcepub fn set_placement_constraints(
self,
input: Option<Vec<PlacementConstraint>>,
) -> Self
pub fn set_placement_constraints( self, input: Option<Vec<PlacementConstraint>>, ) -> Self
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.
Sourcepub fn get_placement_constraints(&self) -> &Option<Vec<PlacementConstraint>>
pub fn get_placement_constraints(&self) -> &Option<Vec<PlacementConstraint>>
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.
Sourcepub fn placement_strategy(self, input: PlacementStrategy) -> Self
pub fn placement_strategy(self, input: PlacementStrategy) -> Self
Appends an item to placementStrategy
.
To override the contents of this collection use set_placement_strategy
.
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.
Sourcepub fn set_placement_strategy(
self,
input: Option<Vec<PlacementStrategy>>,
) -> Self
pub fn set_placement_strategy( self, input: Option<Vec<PlacementStrategy>>, ) -> Self
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.
Sourcepub fn get_placement_strategy(&self) -> &Option<Vec<PlacementStrategy>>
pub fn get_placement_strategy(&self) -> &Option<Vec<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.
Sourcepub fn platform_version(self, input: impl Into<String>) -> Self
pub fn platform_version(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_platform_version(self, input: Option<String>) -> Self
pub fn set_platform_version(self, input: Option<String>) -> Self
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.
Sourcepub fn get_platform_version(&self) -> &Option<String>
pub fn get_platform_version(&self) -> &Option<String>
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.
Sourcepub fn force_new_deployment(self, input: bool) -> Self
pub fn force_new_deployment(self, input: bool) -> Self
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.
Sourcepub fn set_force_new_deployment(self, input: Option<bool>) -> Self
pub fn set_force_new_deployment(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_force_new_deployment(&self) -> &Option<bool>
pub fn get_force_new_deployment(&self) -> &Option<bool>
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.
Sourcepub fn health_check_grace_period_seconds(self, input: i32) -> Self
pub fn health_check_grace_period_seconds(self, input: i32) -> Self
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.
Sourcepub fn set_health_check_grace_period_seconds(self, input: Option<i32>) -> Self
pub fn set_health_check_grace_period_seconds(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_health_check_grace_period_seconds(&self) -> &Option<i32>
pub fn get_health_check_grace_period_seconds(&self) -> &Option<i32>
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.
Sourcepub fn enable_execute_command(self, input: bool) -> Self
pub fn enable_execute_command(self, input: bool) -> Self
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.
Sourcepub fn set_enable_execute_command(self, input: Option<bool>) -> Self
pub fn set_enable_execute_command(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_enable_execute_command(&self) -> &Option<bool>
pub fn get_enable_execute_command(&self) -> &Option<bool>
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.
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.
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.
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.
Sourcepub fn load_balancers(self, input: LoadBalancer) -> Self
pub fn load_balancers(self, input: LoadBalancer) -> Self
Appends an item to loadBalancers
.
To override the contents of this collection use set_load_balancers
.
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.
Sourcepub fn set_load_balancers(self, input: Option<Vec<LoadBalancer>>) -> Self
pub fn set_load_balancers(self, input: Option<Vec<LoadBalancer>>) -> Self
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.
Sourcepub fn get_load_balancers(&self) -> &Option<Vec<LoadBalancer>>
pub fn get_load_balancers(&self) -> &Option<Vec<LoadBalancer>>
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.
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.
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.
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.
Sourcepub fn service_registries(self, input: ServiceRegistry) -> Self
pub fn service_registries(self, input: ServiceRegistry) -> Self
Appends an item to serviceRegistries
.
To override the contents of this collection use set_service_registries
.
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.
Sourcepub fn set_service_registries(self, input: Option<Vec<ServiceRegistry>>) -> Self
pub fn set_service_registries(self, input: Option<Vec<ServiceRegistry>>) -> Self
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.
Sourcepub fn get_service_registries(&self) -> &Option<Vec<ServiceRegistry>>
pub fn get_service_registries(&self) -> &Option<Vec<ServiceRegistry>>
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.
Sourcepub fn service_connect_configuration(
self,
input: ServiceConnectConfiguration,
) -> Self
pub fn service_connect_configuration( self, input: ServiceConnectConfiguration, ) -> Self
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.
Sourcepub fn set_service_connect_configuration(
self,
input: Option<ServiceConnectConfiguration>,
) -> Self
pub fn set_service_connect_configuration( self, input: Option<ServiceConnectConfiguration>, ) -> Self
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.
Sourcepub fn get_service_connect_configuration(
&self,
) -> &Option<ServiceConnectConfiguration>
pub fn get_service_connect_configuration( &self, ) -> &Option<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.
Sourcepub fn volume_configurations(self, input: ServiceVolumeConfiguration) -> Self
pub fn volume_configurations(self, input: ServiceVolumeConfiguration) -> Self
Appends an item to volumeConfigurations
.
To override the contents of this collection use set_volume_configurations
.
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.
Sourcepub fn set_volume_configurations(
self,
input: Option<Vec<ServiceVolumeConfiguration>>,
) -> Self
pub fn set_volume_configurations( self, input: Option<Vec<ServiceVolumeConfiguration>>, ) -> Self
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.
Sourcepub fn get_volume_configurations(
&self,
) -> &Option<Vec<ServiceVolumeConfiguration>>
pub fn get_volume_configurations( &self, ) -> &Option<Vec<ServiceVolumeConfiguration>>
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.
Sourcepub fn vpc_lattice_configurations(self, input: VpcLatticeConfiguration) -> Self
pub fn vpc_lattice_configurations(self, input: VpcLatticeConfiguration) -> Self
Appends an item to vpcLatticeConfigurations
.
To override the contents of this collection use set_vpc_lattice_configurations
.
An object representing the VPC Lattice configuration for the service being updated.
Sourcepub fn set_vpc_lattice_configurations(
self,
input: Option<Vec<VpcLatticeConfiguration>>,
) -> Self
pub fn set_vpc_lattice_configurations( self, input: Option<Vec<VpcLatticeConfiguration>>, ) -> Self
An object representing the VPC Lattice configuration for the service being updated.
Sourcepub fn get_vpc_lattice_configurations(
&self,
) -> &Option<Vec<VpcLatticeConfiguration>>
pub fn get_vpc_lattice_configurations( &self, ) -> &Option<Vec<VpcLatticeConfiguration>>
An object representing the VPC Lattice configuration for the service being updated.
Trait Implementations§
Source§impl Clone for UpdateServiceFluentBuilder
impl Clone for UpdateServiceFluentBuilder
Source§fn clone(&self) -> UpdateServiceFluentBuilder
fn clone(&self) -> UpdateServiceFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateServiceFluentBuilder
impl !RefUnwindSafe for UpdateServiceFluentBuilder
impl Send for UpdateServiceFluentBuilder
impl Sync for UpdateServiceFluentBuilder
impl Unpin for UpdateServiceFluentBuilder
impl !UnwindSafe for UpdateServiceFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);