#include <UpdateServiceRequest.h>
Inheritance diagram for Aws::ECS::Model::UpdateServiceRequest:
Additional Inherited Members | |
| Protected Member Functions inherited from Aws::AmazonWebServiceRequest | |
| virtual void | DumpBodyToUrl (Aws::Http::URI &uri) const |
Detailed Description
Definition at line 27 of file UpdateServiceRequest.h.
Constructor & Destructor Documentation
◆ UpdateServiceRequest()
| Aws::ECS::Model::UpdateServiceRequest::UpdateServiceRequest | ( | ) |
Member Function Documentation
◆ AddCapacityProviderStrategy() [1/2]
|
inline |
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Definition at line 445 of file UpdateServiceRequest.h.
◆ AddCapacityProviderStrategy() [2/2]
|
inline |
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Definition at line 420 of file UpdateServiceRequest.h.
◆ AddPlacementConstraints() [1/2]
|
inline |
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Definition at line 579 of file UpdateServiceRequest.h.
◆ AddPlacementConstraints() [2/2]
|
inline |
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Definition at line 590 of file UpdateServiceRequest.h.
◆ AddPlacementStrategy() [1/2]
|
inline |
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
Definition at line 661 of file UpdateServiceRequest.h.
◆ AddPlacementStrategy() [2/2]
|
inline |
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
Definition at line 671 of file UpdateServiceRequest.h.
◆ CapacityProviderStrategyHasBeenSet()
|
inline |
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Definition at line 295 of file UpdateServiceRequest.h.
◆ ClusterHasBeenSet()
|
inline |
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
Definition at line 55 of file UpdateServiceRequest.h.
◆ DeploymentConfigurationHasBeenSet()
|
inline |
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Definition at line 458 of file UpdateServiceRequest.h.
◆ DesiredCountHasBeenSet()
|
inline |
The number of instantiations of the task to place and keep running in your service.
Definition at line 151 of file UpdateServiceRequest.h.
◆ EnableExecuteCommandHasBeenSet()
|
inline |
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.
Definition at line 867 of file UpdateServiceRequest.h.
◆ ForceNewDeploymentHasBeenSet()
|
inline |
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.
Definition at line 779 of file UpdateServiceRequest.h.
◆ GetCapacityProviderStrategy()
|
inline |
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Definition at line 270 of file UpdateServiceRequest.h.
◆ GetCluster()
|
inline |
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
Definition at line 48 of file UpdateServiceRequest.h.
◆ GetDeploymentConfiguration()
|
inline |
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Definition at line 452 of file UpdateServiceRequest.h.
◆ GetDesiredCount()
|
inline |
The number of instantiations of the task to place and keep running in your service.
Definition at line 145 of file UpdateServiceRequest.h.
◆ GetEnableExecuteCommand()
|
inline |
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.
Definition at line 859 of file UpdateServiceRequest.h.
◆ GetForceNewDeployment()
|
inline |
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.
Definition at line 770 of file UpdateServiceRequest.h.
◆ GetHealthCheckGracePeriodSeconds()
|
inline |
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
Definition at line 811 of file UpdateServiceRequest.h.
◆ GetNetworkConfiguration()
|
inline |
Definition at line 486 of file UpdateServiceRequest.h.
◆ GetPlacementConstraints()
|
inline |
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Definition at line 513 of file UpdateServiceRequest.h.
◆ GetPlacementStrategy()
|
inline |
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
Definition at line 601 of file UpdateServiceRequest.h.
◆ GetPlatformVersion()
|
inline |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Definition at line 683 of file UpdateServiceRequest.h.
◆ GetRequestSpecificHeaders()
|
overridevirtual |
Reimplemented from Aws::ECS::ECSRequest.
◆ GetService()
|
inline |
The name of the service to update.
Definition at line 103 of file UpdateServiceRequest.h.
◆ GetServiceRequestName()
|
inlineoverridevirtual |
Implements Aws::AmazonWebServiceRequest.
Definition at line 36 of file UpdateServiceRequest.h.
◆ GetTaskDefinition()
|
inline |
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.
Definition at line 174 of file UpdateServiceRequest.h.
◆ HealthCheckGracePeriodSecondsHasBeenSet()
|
inline |
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
Definition at line 824 of file UpdateServiceRequest.h.
◆ NetworkConfigurationHasBeenSet()
|
inline |
Definition at line 489 of file UpdateServiceRequest.h.
◆ PlacementConstraintsHasBeenSet()
|
inline |
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Definition at line 524 of file UpdateServiceRequest.h.
◆ PlacementStrategyHasBeenSet()
|
inline |
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
Definition at line 611 of file UpdateServiceRequest.h.
◆ PlatformVersionHasBeenSet()
|
inline |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Definition at line 694 of file UpdateServiceRequest.h.
◆ SerializePayload()
|
overridevirtual |
Convert payload into String.
Implements Aws::AmazonSerializableWebServiceRequest.
◆ ServiceHasBeenSet()
|
inline |
The name of the service to update.
Definition at line 108 of file UpdateServiceRequest.h.
◆ SetCapacityProviderStrategy() [1/2]
|
inline |
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Definition at line 345 of file UpdateServiceRequest.h.
◆ SetCapacityProviderStrategy() [2/2]
|
inline |
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Definition at line 320 of file UpdateServiceRequest.h.
◆ SetCluster() [1/3]
|
inline |
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
Definition at line 69 of file UpdateServiceRequest.h.
◆ SetCluster() [2/3]
|
inline |
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
Definition at line 62 of file UpdateServiceRequest.h.
◆ SetCluster() [3/3]
|
inline |
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
Definition at line 76 of file UpdateServiceRequest.h.
◆ SetDeploymentConfiguration() [1/2]
|
inline |
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Definition at line 464 of file UpdateServiceRequest.h.
◆ SetDeploymentConfiguration() [2/2]
|
inline |
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Definition at line 470 of file UpdateServiceRequest.h.
◆ SetDesiredCount()
|
inline |
The number of instantiations of the task to place and keep running in your service.
Definition at line 157 of file UpdateServiceRequest.h.
◆ SetEnableExecuteCommand()
|
inline |
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.
Definition at line 875 of file UpdateServiceRequest.h.
◆ SetForceNewDeployment()
|
inline |
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.
Definition at line 788 of file UpdateServiceRequest.h.
◆ SetHealthCheckGracePeriodSeconds()
|
inline |
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
Definition at line 837 of file UpdateServiceRequest.h.
◆ SetNetworkConfiguration() [1/2]
|
inline |
Definition at line 492 of file UpdateServiceRequest.h.
◆ SetNetworkConfiguration() [2/2]
|
inline |
Definition at line 495 of file UpdateServiceRequest.h.
◆ SetPlacementConstraints() [1/2]
|
inline |
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Definition at line 546 of file UpdateServiceRequest.h.
◆ SetPlacementConstraints() [2/2]
|
inline |
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Definition at line 535 of file UpdateServiceRequest.h.
◆ SetPlacementStrategy() [1/2]
|
inline |
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
Definition at line 631 of file UpdateServiceRequest.h.
◆ SetPlacementStrategy() [2/2]
|
inline |
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
Definition at line 621 of file UpdateServiceRequest.h.
◆ SetPlatformVersion() [1/3]
|
inline |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Definition at line 716 of file UpdateServiceRequest.h.
◆ SetPlatformVersion() [2/3]
|
inline |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Definition at line 705 of file UpdateServiceRequest.h.
◆ SetPlatformVersion() [3/3]
|
inline |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Definition at line 727 of file UpdateServiceRequest.h.
◆ SetService() [1/3]
|
inline |
The name of the service to update.
Definition at line 118 of file UpdateServiceRequest.h.
◆ SetService() [2/3]
|
inline |
The name of the service to update.
Definition at line 113 of file UpdateServiceRequest.h.
◆ SetService() [3/3]
|
inline |
The name of the service to update.
Definition at line 123 of file UpdateServiceRequest.h.
◆ SetTaskDefinition() [1/3]
|
inline |
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.
Definition at line 204 of file UpdateServiceRequest.h.
◆ SetTaskDefinition() [2/3]
|
inline |
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.
Definition at line 194 of file UpdateServiceRequest.h.
◆ SetTaskDefinition() [3/3]
|
inline |
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.
Definition at line 214 of file UpdateServiceRequest.h.
◆ TaskDefinitionHasBeenSet()
|
inline |
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.
Definition at line 184 of file UpdateServiceRequest.h.
◆ WithCapacityProviderStrategy() [1/2]
|
inline |
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Definition at line 395 of file UpdateServiceRequest.h.
◆ WithCapacityProviderStrategy() [2/2]
|
inline |
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Definition at line 370 of file UpdateServiceRequest.h.
◆ WithCluster() [1/3]
|
inline |
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
Definition at line 90 of file UpdateServiceRequest.h.
◆ WithCluster() [2/3]
|
inline |
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
Definition at line 83 of file UpdateServiceRequest.h.
◆ WithCluster() [3/3]
|
inline |
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
Definition at line 97 of file UpdateServiceRequest.h.
◆ WithDeploymentConfiguration() [1/2]
|
inline |
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Definition at line 476 of file UpdateServiceRequest.h.
◆ WithDeploymentConfiguration() [2/2]
|
inline |
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Definition at line 482 of file UpdateServiceRequest.h.
◆ WithDesiredCount()
|
inline |
The number of instantiations of the task to place and keep running in your service.
Definition at line 163 of file UpdateServiceRequest.h.
◆ WithEnableExecuteCommand()
|
inline |
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.
Definition at line 883 of file UpdateServiceRequest.h.
◆ WithForceNewDeployment()
|
inline |
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.
Definition at line 797 of file UpdateServiceRequest.h.
◆ WithHealthCheckGracePeriodSeconds()
|
inline |
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
Definition at line 850 of file UpdateServiceRequest.h.
◆ WithNetworkConfiguration() [1/2]
|
inline |
Definition at line 498 of file UpdateServiceRequest.h.
◆ WithNetworkConfiguration() [2/2]
|
inline |
Definition at line 501 of file UpdateServiceRequest.h.
◆ WithPlacementConstraints() [1/2]
|
inline |
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Definition at line 568 of file UpdateServiceRequest.h.
◆ WithPlacementConstraints() [2/2]
|
inline |
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
Definition at line 557 of file UpdateServiceRequest.h.
◆ WithPlacementStrategy() [1/2]
|
inline |
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
Definition at line 651 of file UpdateServiceRequest.h.
◆ WithPlacementStrategy() [2/2]
|
inline |
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
Definition at line 641 of file UpdateServiceRequest.h.
◆ WithPlatformVersion() [1/3]
|
inline |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Definition at line 749 of file UpdateServiceRequest.h.
◆ WithPlatformVersion() [2/3]
|
inline |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Definition at line 738 of file UpdateServiceRequest.h.
◆ WithPlatformVersion() [3/3]
|
inline |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Definition at line 760 of file UpdateServiceRequest.h.
◆ WithService() [1/3]
|
inline |
The name of the service to update.
Definition at line 133 of file UpdateServiceRequest.h.
◆ WithService() [2/3]
|
inline |
The name of the service to update.
Definition at line 128 of file UpdateServiceRequest.h.
◆ WithService() [3/3]
|
inline |
The name of the service to update.
Definition at line 138 of file UpdateServiceRequest.h.
◆ WithTaskDefinition() [1/3]
|
inline |
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.
Definition at line 234 of file UpdateServiceRequest.h.
◆ WithTaskDefinition() [2/3]
|
inline |
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.
Definition at line 224 of file UpdateServiceRequest.h.
◆ WithTaskDefinition() [3/3]
|
inline |
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.
Definition at line 244 of file UpdateServiceRequest.h.
The documentation for this class was generated from the following file:
- aws-cpp-sdk-ecs/include/aws/ecs/model/UpdateServiceRequest.h
