# update-service ## Description Modifies the parameters of a service. #### NOTE 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 information, see [Amazon EBS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) 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 information on volumes, see [Amazon EBS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) 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](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) 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](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html) . 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 information, see [Amazon EBS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) 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. #### NOTE 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 ignore `desiredCount` temporarily during a deployment. For example, if `desiredCount` 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 the `RUNNING` state. Tasks for services that use a load balancer are considered healthy if they’re in the `RUNNING` 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, if `desiredCount` 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](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html) 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. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateService) `update-service` uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type `document` must be provided as JSON. Shorthand syntax does not support document types. ## Synopsis ``` update-service [--cluster ] --service [--desired-count ] [--task-definition ] [--capacity-provider-strategy ] [--deployment-configuration ] [--availability-zone-rebalancing ] [--network-configuration ] [--placement-constraints ] [--placement-strategy ] [--platform-version ] [--force-new-deployment | --no-force-new-deployment] [--health-check-grace-period-seconds ] [--deployment-controller ] [--enable-execute-command | --disable-execute-command] [--enable-ecs-managed-tags | --no-enable-ecs-managed-tags] [--load-balancers ] [--propagate-tags ] [--service-registries ] [--service-connect-configuration ] [--volume-configurations ] [--vpc-lattice-configurations ] [--gateway-connectors ] [--monitoring ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] [--help] ``` ## Options `--cluster` (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. `--service` (string) [required] > The name of the service to update. `--desired-count` (integer) > The number of instantiations of the task to place and keep running in your service. > This parameter doesn’t trigger a new service deployment. `--task-definition` (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. > This parameter triggers a new service deployment. `--capacity-provider-strategy` (list) > 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. > #### NOTE > If you want to use Amazon ECS Managed Instances, you must use the `capacityProviderStrategy` request parameter. > 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-parameters.html) . > This parameter doesn’t trigger a new service deployment. > (structure) > > The details of a capacity provider strategy. A capacity provider strategy can be set when using the [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) or [CreateCluster](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html) APIs or as the default capacity provider strategy for a cluster with the `CreateCluster` API. > > Only capacity providers that are already associated with a cluster and have an `ACTIVE` or `UPDATING` status can be used in a capacity provider strategy. The [PutClusterCapacityProviders](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html) API is used to associate a capacity provider with a cluster. > > If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the [CreateClusterCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html) API operation. > > To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy. > > With `FARGATE_SPOT` , you can run interruption tolerant tasks at a rate that’s discounted compared to the `FARGATE` price. `FARGATE_SPOT` runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. `FARGATE_SPOT` supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. `FARGATE_SPOT` supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later. > > A capacity provider strategy can contain a maximum of 20 capacity providers. > > capacityProvider -> (string) [required] > > > The short name of the capacity provider. > > weight -> (integer) > > > The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The `weight` value is taken into consideration after the `base` value, if defined, is satisfied. > > > If no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can’t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0` , any `RunTask` or `CreateService` actions using the capacity provider strategy will fail. > > > Weight value characteristics: > > > * Weight is considered after the base value is satisfied > > > * The default value is `0` if not specified > > > * The valid range is 0 to 1,000 > > > * At least one capacity provider must have a weight greater than zero > > > * Capacity providers with weight of `0` cannot place tasks > > > Task distribution logic: > > > * Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider > > > * Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios > > > Examples: > > > Equal Distribution: Two capacity providers both with weight `1` will split tasks evenly after base requirements are met. > > > Weighted Distribution: If capacityProviderA has weight `1` and capacityProviderB has weight `4` , then for every 1 task on A, 4 tasks will run on B. > > > Constraints: > > > * min: `0` > > > * max: `1000` > > base -> (integer) > > > The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of `0` is used. > > > Base value characteristics: > > > * Only one capacity provider in a strategy can have a base defined > > > * The default value is `0` if not specified > > > * The valid range is 0 to 100,000 > > > * Base requirements are satisfied first before weight distribution > > > Constraints: > > > * min: `0` > > > * max: `100000` Shorthand Syntax: ``` capacityProvider=string,weight=integer,base=integer ... ``` JSON Syntax: ```json [ { "capacityProvider": "string", "weight": integer, "base": integer } ... ] ``` `--deployment-configuration` (structure) > Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. > This parameter doesn’t trigger a new service deployment. > deploymentCircuitBreaker -> (structure) > > #### NOTE > > The deployment circuit breaker can only be used for services using the rolling update (`ECS` ) deployment type. > > The **deployment circuit breaker** determines whether a service deployment will fail if the service can’t reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* > > enable -> (boolean) [required] > > > Determines whether to use the deployment circuit breaker logic for the service. > > rollback -> (boolean) [required] > > > Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. > > resetOnHealthyTask -> (boolean) > > > Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to `true` , a task that reaches a healthy state resets the failure count to `0` . When set to `false` , Amazon ECS does not reset the failure count. The default is `true` . > > thresholdConfiguration -> (structure) > > > The threshold configuration that controls when the deployment circuit breaker triggers. The `type` and `value` together determine how many task failures are tolerated before the circuit breaker activates. > > > type -> (string) [required] > > > > Determines how Amazon ECS uses `value` to calculate the failure threshold. For the percentage types (`BOUNDED_PERCENT` and `UNBOUNDED_PERCENT` ), Amazon ECS multiplies `value` by the latest service desired count. For `COUNT` , Amazon ECS uses `value` directly as the threshold. The default is `BOUNDED_PERCENT` . > > > > Possible values: > > > > * `COUNT` > > > > * `BOUNDED_PERCENT` > > > > * `UNBOUNDED_PERCENT` > > > value -> (integer) [required] > > > > Specifies the integer that Amazon ECS uses to calculate the failure threshold. When `type` is `COUNT` , this value is the failure threshold itself. When `type` is a percentage type, Amazon ECS multiplies this value by the latest service desired count to produce the failure threshold. The default is `50` . > maximumPercent -> (integer) > > If a service is using the rolling update (`ECS` ) deployment type, the `maximumPercent` parameter represents an upper limit on the number of your service’s tasks that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the `desiredCount` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the `REPLICA` service scheduler and has a `desiredCount` of four tasks and a `maximumPercent` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default `maximumPercent` value for a service using the `REPLICA` service scheduler is 200%. > > The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting replacement tasks first and then stopping the unhealthy tasks, as long as cluster resources for starting replacement tasks are available. For more information about how the scheduler replaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) . > > If a service is using either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types, and tasks in the service use the EC2 launch type, the **maximum percent** value is set to the default value. The **maximum percent** value is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state. > > #### NOTE > > You can’t specify a custom `maximumPercent` value for a service that uses either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types and has tasks that use the EC2 launch type. > > If the service uses either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types, and the tasks in the service use the Fargate launch type, the maximum percent value is not used. The value is still returned when describing your service. > minimumHealthyPercent -> (integer) > > If a service is using the rolling update (`ECS` ) deployment type, the `minimumHealthyPercent` represents a lower limit on the number of your service’s tasks that must remain in the `RUNNING` state during a deployment, as a percentage of the `desiredCount` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a `desiredCount` of four tasks and a `minimumHealthyPercent` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. > > If any tasks are unhealthy and if `maximumPercent` doesn’t allow the Amazon ECS scheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one — using the `minimumHealthyPercent` as a constraint — to clear up capacity to launch replacement tasks. For more information about how the scheduler replaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) . > > For services that *do not* use a load balancer, the following should be noted: > > * A service is considered healthy if all essential containers within the tasks in the service pass their health checks. > > * If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a `RUNNING` state before the task is counted towards the minimum healthy percent total. > > * If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. > > For services that *do* use a load balancer, the following should be noted: > > * If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. > > * If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. > > The default value for a replica service for `minimumHealthyPercent` is 100%. The default `minimumHealthyPercent` value for a service using the `DAEMON` service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console. > > The minimum number of healthy tasks during a deployment is the `desiredCount` multiplied by the `minimumHealthyPercent` /100, rounded up to the nearest integer value. > > If a service is using either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types and is running tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value. The **minimum healthy percent** value is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state. > > #### NOTE > > You can’t specify a custom `minimumHealthyPercent` value for a service that uses either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types and has tasks that use the EC2 launch type. > > If a service is using either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service. > alarms -> (structure) > > Information about the CloudWatch alarms. > > alarmNames -> (list) [required] > > > One or more CloudWatch alarm names. Use a “,” to separate the alarms. > > > (string) > > rollback -> (boolean) [required] > > > Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. > > enable -> (boolean) [required] > > > Determines whether to use the CloudWatch alarm option in the service deployment process. > strategy -> (string) > > The deployment strategy for the service. Choose from these valid values: > > * `ROLLING` - When you create a service which uses the rolling update (`ROLLING` ) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. > > * `BLUE_GREEN` - A blue/green deployment strategy (`BLUE_GREEN` ) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed. > > * `LINEAR` - A *linear* deployment strategy (`LINEAR` ) gradually shifts traffic from the current production environment to a new environment in equal percentages over time. With Amazon ECS linear deployments, you can control the pace of traffic shifting and validate new service revisions with increasing amounts of production traffic. > > * `CANARY` - A *canary* deployment strategy (`CANARY` ) shifts a small percentage of traffic to the new service revision first, then shifts the remaining traffic all at once after a specified time period. This allows you to test the new version with a subset of users before full deployment. > > Possible values: > > * `ROLLING` > > * `BLUE_GREEN` > > * `LINEAR` > > * `CANARY` > bakeTimeInMinutes -> (integer) > > The time period when both blue and green service revisions are running simultaneously after the production traffic has shifted. > > You must provide this parameter when you use the `BLUE_GREEN` deployment strategy. > lifecycleHooks -> (list) > > An array of deployment lifecycle hook objects to run custom logic or pause the deployment at specific stages of the deployment lifecycle. > > (structure) > > > A deployment lifecycle hook runs custom logic or pauses the deployment at specific stages of the deployment process. You can use Lambda functions or pause hooks as hook targets. > > > For more information, see [Lifecycle hooks for Amazon ECS service deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-lifecycle-hooks.html) in the *Amazon Elastic Container Service Developer Guide* . > > > targetType -> (string) > > > > The type of action the lifecycle hook performs. Valid values are: > > > > * `AWS_LAMBDA` - Invokes a Lambda function at the specified lifecycle stage. This is the default value. > > > > * `PAUSE` - Pauses the deployment at the specified lifecycle stage until you call `ContinueServiceDeployment` to continue or roll back. > > > > This field is optional. If not specified, the default value is `AWS_LAMBDA` . > > > > Possible values: > > > > * `AWS_LAMBDA` > > > > * `PAUSE` > > > hookTargetArn -> (string) > > > > The Amazon Resource Name (ARN) of the hook target. For `AWS_LAMBDA` hooks, this is the Lambda function ARN. This field is not applicable for `PAUSE` hooks. > > > > You must provide this parameter when configuring an `AWS_LAMBDA` lifecycle hook. > > > roleArn -> (string) > > > > The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf. > > > > For more information, see [Permissions required for Lambda functions in Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-permissions.html) in the *Amazon Elastic Container Service Developer Guide* . > > > lifecycleStages -> (list) > > > > The lifecycle stages at which to run the hook. Choose from these valid values: > > > > * RECONCILE_SERVICE The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state. You can use a lifecycle hook for this stage. > > > > * PRE_SCALE_UP The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic. You can use a lifecycle hook for this stage. > > > > * POST_SCALE_UP The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic. You can use a lifecycle hook for this stage. > > > > * TEST_TRAFFIC_SHIFT The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic. You can use a lifecycle hook for this stage. > > > > * POST_TEST_TRAFFIC_SHIFT The test traffic shift is complete. The green service revision handles 100% of the test traffic. You can use a lifecycle hook for this stage. > > > > * PRE_PRODUCTION_TRAFFIC_SHIFT Occurs before production traffic shift. For linear and canary deployments, this stage is invoked before every traffic shift step. You can use a lifecycle hook for this stage. > > > > * PRODUCTION_TRAFFIC_SHIFT Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic. For linear and canary deployments, this stage is invoked at every traffic shift step. You can use a lifecycle hook for this stage. > > > > * POST_PRODUCTION_TRAFFIC_SHIFT The production traffic shift is complete. You can use a lifecycle hook for this stage. > > > > #### NOTE > > > > `PAUSE` hooks cannot be configured at `TEST_TRAFFIC_SHIFT` or `PRODUCTION_TRAFFIC_SHIFT` stages. These stages are only valid for `AWS_LAMBDA` hooks. > > > > You must provide this parameter when configuring a deployment lifecycle hook. > > > > (string) > > > > > Possible values: > > > > > * `RECONCILE_SERVICE` > > > > > * `PRE_SCALE_UP` > > > > > * `POST_SCALE_UP` > > > > > * `TEST_TRAFFIC_SHIFT` > > > > > * `POST_TEST_TRAFFIC_SHIFT` > > > > > * `PRE_PRODUCTION_TRAFFIC_SHIFT` > > > > > * `PRODUCTION_TRAFFIC_SHIFT` > > > > > * `POST_PRODUCTION_TRAFFIC_SHIFT` > > > hookDetails -> (document) > > > > Use this field to specify custom parameters that Amazon ECS passes to your Lambda function on each invocation. This field is not used for `PAUSE` hooks. > > > timeoutConfiguration -> (structure) > > > > The timeout configuration for the lifecycle hook. This specifies how long Amazon ECS waits before taking the timeout action if the hook is not resolved. > > > > timeoutInMinutes -> (integer) > > > > > The number of minutes Amazon ECS waits for the lifecycle hook to complete before taking the timeout action. > > > > > Default: 1440 (24 hours) > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `20160` > > > > action -> (string) > > > > > The action Amazon ECS takes when the lifecycle hook times out. Valid values are: > > > > > * `CONTINUE` - Proceeds the deployment to the next lifecycle stage. > > > > > * `ROLLBACK` - Rolls back the deployment to the previous service revision. > > > > > Default: `ROLLBACK` > > > > > Possible values: > > > > > * `ROLLBACK` > > > > > * `CONTINUE` > linearConfiguration -> (structure) > > Configuration for linear deployment strategy. Only valid when the deployment strategy is `LINEAR` . This configuration enables progressive traffic shifting in equal percentage increments with configurable bake times between each step. > > stepPercent -> (double) > > > The percentage of production traffic to shift in each step during a linear deployment. Valid values are multiples of 0.1 from 3.0 to 100.0. The default value is 10.0. > > stepBakeTimeInMinutes -> (integer) > > > The amount of time in minutes to wait between each traffic shifting step during a linear deployment. Valid values are 0 to 1440 minutes (24 hours). The default value is 6. This bake time is not applied after reaching 100 percent traffic. > canaryConfiguration -> (structure) > > Configuration for canary deployment strategy. Only valid when the deployment strategy is `CANARY` . This configuration enables shifting a fixed percentage of traffic for testing, followed by shifting the remaining traffic after a bake period. > > canaryPercent -> (double) > > > The percentage of production traffic to shift to the new service revision during the canary phase. Valid values are multiples of 0.1 from 0.1 to 100.0. The default value is 5.0. > > canaryBakeTimeInMinutes -> (integer) > > > The amount of time in minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision. Valid values are 0 to 1440 minutes (24 hours). The default value is 10. > earlySuccessCriteria -> (structure) > > The early success criteria configuration for a rolling deployment. With early success criteria, you can configure an Amazon ECS deployment to complete faster. Amazon ECS declares a deployment successful once a target percentage of tasks are healthy, instead of waiting for the service to fully stabilize. > > enable -> (boolean) [required] > > > Specifies whether to use the early success criteria for the service deployment. When set to `false` , the deployment uses the default behavior, where Amazon ECS considers the deployment successful when the target service revision fully stabilizes and the previous tasks are removed. The default value is `false` . > > > When set to `true` , Amazon ECS monitors the deployment to meet early success criteria. You must also specify `healthyPercent` and `sourceServiceRevisionCleanup` . > > healthyPercent -> (integer) > > > The percentage of healthy tasks that the target service revision must reach before Amazon ECS considers the deployment successful. This percentage is relative to the service’s `desiredCount` and must be an integer between `0` and `100` . This value must be greater than or equal to the `minimumHealthyPercent` value. > > > After this percentage of tasks is healthy and the bake time elapses, Amazon ECS completes the deployment. Amazon ECS continues to scale the target service revision to 100 percent in the background. > > > Constraints: > > > * min: `0` > > > * max: `100` > > sourceServiceRevisionCleanup -> (string) > > > The time when Amazon ECS removes the source revisions’ tasks relative to deployment completion. The valid values are: > > > * `BLOCKING` —Amazon ECS removes the previous tasks before it marks the deployment as successful. > > > * `DEFERRED` —Amazon ECS marks the deployment successful, and then removes the previous tasks in the background. > > > Possible values: > > > * `BLOCKING` > > > * `DEFERRED` JSON Syntax: ```json { "deploymentCircuitBreaker": { "enable": true|false, "rollback": true|false, "resetOnHealthyTask": true|false, "thresholdConfiguration": { "type": "COUNT"|"BOUNDED_PERCENT"|"UNBOUNDED_PERCENT", "value": integer } }, "maximumPercent": integer, "minimumHealthyPercent": integer, "alarms": { "alarmNames": ["string", ...], "rollback": true|false, "enable": true|false }, "strategy": "ROLLING"|"BLUE_GREEN"|"LINEAR"|"CANARY", "bakeTimeInMinutes": integer, "lifecycleHooks": [ { "targetType": "AWS_LAMBDA"|"PAUSE", "hookTargetArn": "string", "roleArn": "string", "lifecycleStages": ["RECONCILE_SERVICE"|"PRE_SCALE_UP"|"POST_SCALE_UP"|"TEST_TRAFFIC_SHIFT"|"POST_TEST_TRAFFIC_SHIFT"|"PRE_PRODUCTION_TRAFFIC_SHIFT"|"PRODUCTION_TRAFFIC_SHIFT"|"POST_PRODUCTION_TRAFFIC_SHIFT", ...], "hookDetails": {...}, "timeoutConfiguration": { "timeoutInMinutes": integer, "action": "ROLLBACK"|"CONTINUE" } } ... ], "linearConfiguration": { "stepPercent": double, "stepBakeTimeInMinutes": integer }, "canaryConfiguration": { "canaryPercent": double, "canaryBakeTimeInMinutes": integer }, "earlySuccessCriteria": { "enable": true|false, "healthyPercent": integer, "sourceServiceRevisionCleanup": "BLOCKING"|"DEFERRED" } } ``` `--availability-zone-rebalancing` (string) > Indicates whether to use Availability Zone rebalancing for the service. > For more information, see [Balancing an Amazon ECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the \* *Amazon Elastic Container Service Developer Guide* \* . > The default behavior of `AvailabilityZoneRebalancing` differs between create and update requests: > * For create service requests, when no value is specified for `AvailabilityZoneRebalancing` , Amazon ECS defaults the value to `ENABLED` . > * For update service requests, when no value is specified for `AvailabilityZoneRebalancing` , Amazon ECS defaults to the existing service’s `AvailabilityZoneRebalancing` value. If the service never had an `AvailabilityZoneRebalancing` value set, Amazon ECS treats this as `DISABLED` . > This parameter doesn’t trigger a new service deployment. > Possible values: > * `ENABLED` > * `DISABLED` `--network-configuration` (structure) > An object representing the network configuration for the service. > This parameter triggers a new service deployment. > awsvpcConfiguration -> (structure) > > The VPC subnets and security groups that are associated with a task. > > #### NOTE > > All specified subnets and security groups must be from the same VPC. > > subnets -> (list) [required] > > > The IDs of the subnets associated with the task or service. There’s a limit of 16 subnets that can be specified. > > > #### NOTE > > > All specified subnets must be from the same VPC. > > > (string) > > securityGroups -> (list) > > > The IDs of the security groups associated with the task or service. If you don’t specify a security group, the default security group for the VPC is used. There’s a limit of 5 security groups that can be specified. > > > #### NOTE > > > All specified security groups must be from the same VPC. > > > (string) > > assignPublicIp -> (string) > > > Whether the task’s elastic network interface receives a public IP address. > > > Consider the following when you set this value: > > > * When you use `create-service` or `update-service` , the default is `DISABLED` . > > > * When the service `deploymentController` is `ECS` , the value must be `DISABLED` . > > > Possible values: > > > * `ENABLED` > > > * `DISABLED` Shorthand Syntax: ``` awsvpcConfiguration={subnets=[string,string],securityGroups=[string,string],assignPublicIp=string} ``` JSON Syntax: ```json { "awsvpcConfiguration": { "subnets": ["string", ...], "securityGroups": ["string", ...], "assignPublicIp": "ENABLED"|"DISABLED" } } ``` `--placement-constraints` (list) > 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 parameter doesn’t trigger a new service deployment. > (structure) > > An object representing a constraint on task placement. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide* . > > #### NOTE > > If you’re using the Fargate launch type, task placement constraints aren’t supported. > > type -> (string) > > > The type of constraint. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance. Use `memberOf` to restrict the selection to a group of valid candidates. > > > Possible values: > > > * `distinctInstance` > > > * `memberOf` > > expression -> (string) > > > A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can’t specify an expression if the constraint type is `distinctInstance` . For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide* . Shorthand Syntax: ``` type=string,expression=string ... ``` JSON Syntax: ```json [ { "type": "distinctInstance"|"memberOf", "expression": "string" } ... ] ``` `--placement-strategy` (list) > 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 parameter doesn’t trigger a new service deployment. > (structure) > > The task placement strategy for a task or service. For more information, see [Task placement strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide* . > > type -> (string) > > > The type of placement strategy. The `random` placement strategy randomly places tasks on available candidates. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that’s specified with the `field` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task. > > > Possible values: > > > * `random` > > > * `spread` > > > * `binpack` > > field -> (string) > > > The field to apply the placement strategy against. For the `spread` placement strategy, valid values are `instanceId` (or `host` , which has the same effect), or any platform or custom attribute that’s applied to a container instance, such as `attribute:ecs.availability-zone` . For the `binpack` placement strategy, valid values are `cpu` and `memory` . For the `random` placement strategy, this field is not used. Shorthand Syntax: ``` type=string,field=string ... ``` JSON Syntax: ```json [ { "type": "random"|"spread"|"binpack", "field": "string" } ... ] ``` `--platform-version` (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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* . > This parameter triggers a new service deployment. `--force-new-deployment` | `--no-force-new-deployment` (boolean) > 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. `--health-check-grace-period-seconds` (integer) > 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. > If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count. > This parameter doesn’t trigger a new service deployment. `--deployment-controller` (structure) > The deployment controller to use for the service. > type -> (string) [required] > > The deployment controller type to use. > > The deployment controller is the mechanism that determines how tasks are deployed for your service. The valid options are: > > * ECS When you create a service which uses the `ECS` deployment controller, you can choose between the following deployment strategies: > > * `ROLLING` : When you create a service which uses the *rolling update* (`ROLLING` ) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. Rolling update deployments are best suited for the following scenarios: > > * Gradual service updates: You need to update your service incrementally without taking the entire service offline at once. > > * Limited resource requirements: You want to avoid the additional resource costs of running two complete environments simultaneously (as required by blue/green deployments). > > * Acceptable deployment time: Your application can tolerate a longer deployment process, as rolling updates replace tasks one by one. > > * No need for instant roll back: Your service can tolerate a rollback process that takes minutes rather than seconds. > > * Simple deployment process: You prefer a straightforward deployment approach without the complexity of managing multiple environments, target groups, and listeners. > > * No load balancer requirement: Your service doesn’t use or require a load balancer, Application Load Balancer, Network Load Balancer, or Service Connect (which are required for blue/green deployments). > > * Stateful applications: Your application maintains state that makes it difficult to run two parallel environments. > > * Cost sensitivity: You want to minimize deployment costs by not running duplicate environments during deployment. > > Rolling updates are the default deployment strategy for services and provide a balance between deployment safety and resource efficiency for many common application scenarios. > > * `BLUE_GREEN` : A *blue/green* deployment strategy (`BLUE_GREEN` ) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed. Amazon ECS blue/green deployments are best suited for the following scenarios: > > * Service validation: When you need to validate new service revisions before directing production traffic to them > > * Zero downtime: When your service requires zero-downtime deployments > > * Instant roll back: When you need the ability to quickly roll back if issues are detected > > * Load balancer requirement: When your service uses Application Load Balancer, Network Load Balancer, or Service Connect > > * External Use a third-party deployment controller. > > * Blue/green deployment (powered by CodeDeploy) CodeDeploy installs an updated version of the application as a new replacement task set and reroutes production traffic from the original application task set to the replacement task set. The original task set is terminated after a successful deployment. Use this deployment controller to verify a new deployment of a service before sending production traffic to it. > > Possible values: > > * `ECS` > > * `CODE_DEPLOY` > > * `EXTERNAL` Shorthand Syntax: ``` type=string ``` JSON Syntax: ```json { "type": "ECS"|"CODE_DEPLOY"|"EXTERNAL" } ``` `--enable-execute-command` | `--disable-execute-command` (boolean) > 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. > This parameter doesn’t trigger a new service deployment. `--enable-ecs-managed-tags` | `--no-enable-ecs-managed-tags` (boolean) > Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) 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. > This parameter doesn’t trigger a new service deployment. `--load-balancers` (list) > #### NOTE > 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](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) \`\` 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) 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](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html) . Note that multiple target groups are not supported for external deployments. For more information see [Register multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide* . > You can remove existing `loadBalancers` by passing an empty list. > This parameter triggers a new service deployment. > (structure) > > The load balancer configuration to use with a service or task set. > > When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers. > > We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration. > > A service-linked role is required for services that use multiple target groups. For more information, see [Using service-linked roles](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide* . > > targetGroupArn -> (string) > > > The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. > > > A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. > > > For services using the `ECS` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide* . > > > For services using the `CODE_DEPLOY` deployment controller, you’re required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide* . > > > #### WARNING > > > If your service’s task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance` . Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type. > > loadBalancerName -> (string) > > > The name of the load balancer to associate with the Amazon ECS service or task set. > > > If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted. > > containerName -> (string) > > > The name of the container (as it appears in a container definition) to associate with the load balancer. > > > You need to specify the container name when configuring the target group for an Amazon ECS load balancer. > > containerPort -> (integer) > > > The port on the container to associate with the load balancer. This port must correspond to a `containerPort` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they’re launched on must allow ingress traffic on the `hostPort` of the port mapping. > > advancedConfiguration -> (structure) > > > The advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments. > > > alternateTargetGroupArn -> (string) > > > > The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments. > > > productionListenerRule -> (string) > > > > The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic. > > > testListenerRule -> (string) > > > > The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic. > > > roleArn -> (string) > > > > The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you. Shorthand Syntax: ``` targetGroupArn=string,loadBalancerName=string,containerName=string,containerPort=integer,advancedConfiguration={alternateTargetGroupArn=string,productionListenerRule=string,testListenerRule=string,roleArn=string} ... ``` JSON Syntax: ```json [ { "targetGroupArn": "string", "loadBalancerName": "string", "containerName": "string", "containerPort": integer, "advancedConfiguration": { "alternateTargetGroupArn": "string", "productionListenerRule": "string", "testListenerRule": "string", "roleArn": "string" } } ... ] ``` `--propagate-tags` (string) > 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. > This parameter doesn’t trigger a new service deployment. > Possible values: > * `TASK_DEFINITION` > * `SERVICE` > * `NONE` `--service-registries` (list) > #### NOTE > You must have a service-linked role when you update this property. > For more information about the role see the `CreateService` request parameter \` `role` [https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request)-role\`_\_ . > The details for the service discovery registries to assign to this service. For more information, see [Service Discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) . > 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 parameter triggers a new service deployment. > (structure) > > The details for the service registry. > > Each service may be associated with one service registry. Multiple service registries for each service are not supported. > > When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration. > > registryArn -> (string) > > > The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html) . > > port -> (integer) > > > The port value used if your service discovery service specified an SRV record. This field might be used if both the `awsvpc` network mode and SRV records are used. > > containerName -> (string) > > > The container name value to be used for your service discovery service. It’s already specified in the task definition. If the task definition that your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition that your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can’t specify both. > > containerPort -> (integer) > > > The port value to be used for your service discovery service. It’s already specified in the task definition. If the task definition your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can’t specify both. Shorthand Syntax: ``` registryArn=string,port=integer,containerName=string,containerPort=integer ... ``` JSON Syntax: ```json [ { "registryArn": "string", "port": integer, "containerName": "string", "containerPort": integer } ... ] ``` `--service-connect-configuration` (structure) > 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > This parameter triggers a new service deployment. > enabled -> (boolean) [required] > > Specifies whether to use Service Connect with this service. > namespace -> (string) > > The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn’t affect Service Connect. For more information about Cloud Map, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Cloud Map Developer Guide* . > services -> (list) > > The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. > > This field is not required for a “client” Amazon ECS service that’s a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that’s attached to the service or by other means. > > An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service. > > (structure) > > > The Service Connect service object configuration. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > portName -> (string) [required] > > > > The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service. > > > discoveryName -> (string) > > > > The `discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can’t start with a hyphen. > > > > If the `discoveryName` isn’t specified, the port mapping name from the task definition is used in `portName.namespace` . > > > clientAliases -> (list) > > > > The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. > > > > Each alias (“endpoint”) is a fully-qualified name and port number that other Amazon ECS tasks (“clients”) can use to connect to this service. > > > > Each name and port mapping must be unique within the namespace. > > > > For each `ServiceConnectService` , you must provide at least one `clientAlias` with one `port` . > > > > (structure) > > > > > Each alias (“endpoint”) is a fully-qualified name and port number that other tasks (“clients”) can use to connect to this service. > > > > > Each name and port mapping must be unique within the 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > port -> (integer) [required] > > > > > > The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. > > > > > > To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `65535` > > > > > dnsName -> (string) > > > > > > The `dnsName` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn’t need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can’t start with a hyphen. > > > > > > If this parameter isn’t specified, the default value of `discoveryName.namespace` is used. If the `discoveryName` isn’t specified, the port mapping name from the task definition is used in `portName.namespace` . > > > > > > To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are `database` , `db` , or the lowercase name of a database, such as `mysql` or `redis` . For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > testTrafficRules -> (structure) > > > > > > The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic. > > > > > > header -> (structure) [required] > > > > > > > The HTTP header-based routing rules that determine which requests should be routed to the new service version during blue/green deployment testing. These rules provide fine-grained control over test traffic routing based on request headers. > > > > > > > name -> (string) [required] > > > > > > > > The name of the HTTP header to examine for test traffic routing. Common examples include custom headers like `X-Test-Version` or `X-Canary-Request` that can be used to identify test traffic. > > > > > > > value -> (structure) > > > > > > > > The header value matching configuration that determines how the HTTP header value is evaluated for test traffic routing decisions. > > > > > > > > exact -> (string) [required] > > > > > > > > > The exact value that the HTTP header must match for the test traffic routing rule to apply. This provides precise control over which requests are routed to the new service revision during blue/green deployments. > > > ingressPortOverride -> (integer) > > > > The port number for the Service Connect proxy to listen on. > > > > Use the value of this field to bypass the proxy for traffic on the port number specified in the named `portMapping` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. > > > > In `awsvpc` mode and Fargate, the default value is the container port number. The container port number is in the `portMapping` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy. > > > > Constraints: > > > > * min: `0` > > > > * max: `65535` > > > timeout -> (structure) > > > > A reference to an object that represents the configured timeouts for Service Connect. > > > > idleTimeoutSeconds -> (integer) > > > > > The amount of time in seconds a connection will stay active while idle. A value of `0` can be set to disable `idleTimeout` . > > > > > The `idleTimeout` default for `HTTP` /`HTTP2` /`GRPC` is 5 minutes. > > > > > The `idleTimeout` default for `TCP` is 1 hour. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `2147483647` > > > > perRequestTimeoutSeconds -> (integer) > > > > > The amount of time waiting for the upstream to respond with a complete response per request. A value of `0` can be set to disable `perRequestTimeout` . `perRequestTimeout` can only be set if Service Connect `appProtocol` isn’t `TCP` . Only `idleTimeout` is allowed for `TCP` `appProtocol` . > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `2147483647` > > > tls -> (structure) > > > > A reference to an object that represents a Transport Layer Security (TLS) configuration. > > > > issuerCertificateAuthority -> (structure) [required] > > > > > The signer certificate authority. > > > > > awsPcaAuthorityArn -> (string) > > > > > > The ARN of the Amazon Web Services Private Certificate Authority certificate. > > > > kmsKey -> (string) > > > > > The Amazon Web Services Key Management Service key. > > > > roleArn -> (string) > > > > > The Amazon Resource Name (ARN) of the IAM role that’s associated with the Service Connect TLS. > logConfiguration -> (structure) > > The log configuration for the container. This parameter maps to `LogConfig` in the docker container create command and the `--log-driver` option to docker run. > > By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. > > Understand the following when specifying a log configuration for your containers. > > * Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on Fargate, the supported log drivers are `awslogs` , `splunk` , and `awsfirelens` . For tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs` , `fluentd` , `gelf` , `json-file` , `journald` ,\`\`syslog\`\` , `splunk` , and `awsfirelens` . For tasks on Amazon ECS Managed Instances, the supported log drivers are `awslogs` , `splunk` , `awsfirelens` , and `json-file` . > > * This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. > > * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* . > > * For tasks that are on Fargate, because you don’t have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. > > logDriver -> (string) [required] > > > The log driver to use for the container. > > > For tasks on Fargate, the supported log drivers are `awslogs` , `splunk` , and `awsfirelens` . > > > For tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs` , `fluentd` , `gelf` , `json-file` , `journald` , `syslog` , `splunk` , and `awsfirelens` . > > > For tasks on Amazon ECS Managed Instances, the supported log drivers are `awslogs` , `splunk` , `awsfirelens` , and `json-file` . > > > For more information about using the `awslogs` log driver, see [Send Amazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide* . > > > For more information about using the `awsfirelens` log driver, see [Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) . > > > #### NOTE > > > If you have a custom driver that isn’t listed, you can fork the Amazon ECS container agent project that’s [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don’t currently provide support for running modified copies of this software. > > > Possible values: > > > * `json-file` > > > * `syslog` > > > * `journald` > > > * `gelf` > > > * `fluentd` > > > * `awslogs` > > > * `splunk` > > > * `awsfirelens` > > options -> (map) > > > The configuration options to send to the log driver. > > > The options you can specify depend on the log driver. Some of the options you can specify when you use the `awslogs` log driver to route logs to Amazon CloudWatch include the following: > > > > awslogs-create-group > > > Required: No > > > Specify whether you want the log group to be created automatically. If this option isn’t specified, it defaults to `false` . > > > #### NOTE > > > Your IAM policy must include the `logs:CreateLogGroup` permission before you attempt to use `awslogs-create-group` . > > > awslogs-region > > > Required: Yes > > > Specify the Amazon Web Services Region that the `awslogs` log driver is to send your Docker logs to. You can choose to send all of your logs from clusters in different Regions to a single region in CloudWatch Logs. This is so that they’re all visible in one location. Otherwise, you can separate them by Region for more granularity. Make sure that the specified log group exists in the Region that you specify with this option. > > > > awslogs-group > > > Required: Yes > > > Make sure to specify a log group that the `awslogs` log driver sends its log streams to. > > > > awslogs-stream-prefix > > > Required: Yes, when using Fargate.Optional when using EC2. > > > Use the `awslogs-stream-prefix` option to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task that the container belongs to. If you specify a prefix with this option, then the log stream takes the format `prefix-name/container-name/ecs-task-id` . > > > If you don’t specify a prefix with this option, then the log stream is named after the container ID that’s assigned by the Docker daemon on the container instance. Because it’s difficult to trace logs back to the container that sent them with just the Docker container ID (which is only available on the container instance), we recommend that you specify a prefix with this option. > > > For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace log streams to the service that the container belongs to, the name of the container that sent them, and the ID of the task that the container belongs to. > > > You must specify a stream-prefix for your logs to have your logs appear in the Log pane when using the Amazon ECS console. > > > > awslogs-datetime-format > > > Required: No > > > This option defines a multiline start pattern in Python `strftime` format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. > > > One example of a use case for using this format is for parsing output such as a stack dump, which might otherwise be logged in multiple entries. The correct pattern allows it to be captured in a single entry. > > > For more information, see [awslogs-datetime-format](https://docs.docker.com/config/containers/logging/awslogs/#awslogs-datetime-format) . > > > You cannot configure both the `awslogs-datetime-format` and `awslogs-multiline-pattern` options. > > > #### NOTE > > > Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. > > > awslogs-multiline-pattern > > > Required: No > > > This option defines a multiline start pattern that uses a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. > > > For more information, see [awslogs-multiline-pattern](https://docs.docker.com/config/containers/logging/awslogs/#awslogs-multiline-pattern) . > > > This option is ignored if `awslogs-datetime-format` is also configured. > > > You cannot configure both the `awslogs-datetime-format` and `awslogs-multiline-pattern` options. > > > #### NOTE > > > Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. > > > The following options apply to all supported log drivers. > > > > mode > > > Required: No > > > Valid values: `non-blocking` | `blocking` > > > This option defines the delivery mode of log messages from the container to the log driver specified using `logDriver` . The delivery mode you choose affects application availability when the flow of logs from container is interrupted. > > > If you use the `blocking` mode and the flow of logs is interrupted, calls from container code to write to the `stdout` and `stderr` streams will block. The logging thread of the application will block as a result. This may cause the application to become unresponsive and lead to container healthcheck failure. > > > If you use the `non-blocking` mode, the container’s logs are instead stored in an in-memory intermediate buffer configured with the `max-buffer-size` option. This prevents the application from becoming unresponsive when logs cannot be sent. We recommend using this mode if you want to ensure service availability and are okay with some log loss. For more information, see Preventing log loss with non-blocking mode in the \`\`awslogs\` container log driver <[http://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/](http://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/)>\`_\_ . > > > You can set a default `mode` for all containers in a specific Amazon Web Services Region by using the `defaultLogDriverMode` account setting. If you don’t specify the `mode` option or configure the account setting, Amazon ECS will default to the `non-blocking` mode. For more information about the account setting, see [Default log driver mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#default-log-driver-mode) in the *Amazon Elastic Container Service Developer Guide* . > > > #### NOTE > > > On June 25, 2025, Amazon ECS changed the default log driver mode from `blocking` to `non-blocking` to prioritize task availability over logging. To continue using the `blocking` mode after this change, do one of the following: > > > * Set the `mode` option in your container definition’s `logConfiguration` as `blocking` . > > > * Set the `defaultLogDriverMode` account setting to `blocking` . > > > max-buffer-size > > > Required: No > > > Default value: `10m` > > > When `non-blocking` mode is used, the `max-buffer-size` log option controls the size of the buffer that’s used for intermediate message storage. Make sure to specify an adequate buffer size based on your application. When the buffer fills up, further logs cannot be stored. Logs that cannot be stored are lost. > > > To route logs using the `splunk` log router, you need to specify a `splunk-token` and a `splunk-url` . > > > When you use the `awsfirelens` log router to route logs to an Amazon Web Services Service or Amazon Web Services Partner Network destination for log storage and analytics, you can set the `log-driver-buffer-limit` option to limit the number of events that are buffered in memory, before being sent to the log router container. It can help to resolve potential log loss issue because high throughput might result in memory running out for the buffer inside of Docker. > > > Other options you can specify when using `awsfirelens` to route logs depend on the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region with `region` and a name for the log stream with `delivery_stream` . > > > When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with `region` and a data stream name with `stream` . > > > When you export logs to Amazon OpenSearch Service, you can specify options like `Name` , `Host` (OpenSearch Service endpoint without protocol), `Port` , `Index` , `Type` , `Aws_auth` , `Aws_region` , `Suppress_Type_Name` , and `tls` . For more information, see [Under the hood: FireLens for Amazon ECS Tasks](http://aws.amazon.com/blogs/containers/under-the-hood-firelens-for-amazon-ecs-tasks/) . > > > When you export logs to Amazon S3, you can specify the bucket using the `bucket` option. You can also specify `region` , `total_file_size` , `upload_timeout` , and `use_put_object` as options. > > > This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` > > > key -> (string) > > > value -> (string) > > secretOptions -> (list) > > > The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide* . > > > (structure) > > > > An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways: > > > > * To inject sensitive data into your containers as environment variables, use the `secrets` container definition parameter. > > > > * To reference sensitive information in the log configuration of a container, use the `secretOptions` container definition parameter. > > > > For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > name -> (string) [required] > > > > > The name of the secret. > > > > valueFrom -> (string) [required] > > > > > The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store. > > > > > For information about the require Identity and Access Management permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide* . > > > > > #### NOTE > > > > > If the SSM Parameter Store parameter exists in the same Region as the task you’re launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. > accessLogConfiguration -> (structure) > > The configuration for Service Connect access logging. Access logs capture detailed information about requests made to your service, including request patterns, response codes, and timing data. They can be useful for debugging connectivity issues, monitoring service performance, and auditing service-to-service communication for security and compliance purposes. > > #### NOTE > > To enable access logs, you must also specify a `logConfiguration` in the `serviceConnectConfiguration` . > > format -> (string) [required] > > > The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools. > > > Possible values: > > > * `TEXT` > > > * `JSON` > > includeQueryParameters -> (string) > > > Specifies whether to include query parameters in Service Connect access logs. > > > When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is `DISABLED` . > > > Possible values: > > > * `DISABLED` > > > * `ENABLED` > containerConfigurations -> (list) > > The settings for the Service Connect proxy container that Amazon ECS adds to each task in this service. Each object in the list sets exactly one setting, and each setting can appear only once in the list. > > Your changes to these settings apply only to tasks that Amazon ECS launches after you update the service. Your running tasks keep their existing settings until Amazon ECS replaces them. If you update the `serviceConnectConfiguration` of your service and don’t include `containerConfigurations` , the proxy container settings return to their defaults. > > Constraints: > > * min: `0` > > * max: `10` > > (tagged union structure) > > > Contains a configuration setting for the Service Connect proxy container, such as the log level. Specify exactly one member in each object. > > > #### NOTE > > > This is a Tagged Union structure. Only one of the following top level keys can be set: `logLevel`. > > > logLevel -> (string) > > > > The log level of the Service Connect proxy container. Set the log level to `debug` to collect more detailed proxy logs when you troubleshoot connectivity issues between services, and set it back to `info` when you finish. Debug logging increases the volume of logs that the proxy container writes. If you don’t specify a log level, the default is `info` . > > > > Possible values: > > > > * `debug` > > > > * `info` JSON Syntax: ```json { "enabled": true|false, "namespace": "string", "services": [ { "portName": "string", "discoveryName": "string", "clientAliases": [ { "port": integer, "dnsName": "string", "testTrafficRules": { "header": { "name": "string", "value": { "exact": "string" } } } } ... ], "ingressPortOverride": integer, "timeout": { "idleTimeoutSeconds": integer, "perRequestTimeoutSeconds": integer }, "tls": { "issuerCertificateAuthority": { "awsPcaAuthorityArn": "string" }, "kmsKey": "string", "roleArn": "string" } } ... ], "logConfiguration": { "logDriver": "json-file"|"syslog"|"journald"|"gelf"|"fluentd"|"awslogs"|"splunk"|"awsfirelens", "options": {"string": "string" ...}, "secretOptions": [ { "name": "string", "valueFrom": "string" } ... ] }, "accessLogConfiguration": { "format": "TEXT"|"JSON", "includeQueryParameters": "DISABLED"|"ENABLED" }, "containerConfigurations": [ { "logLevel": "debug"|"info" } ... ] } ``` `--volume-configurations` (list) > The details of the volume that was `configuredAtLaunch` . You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in [ServiceManagedEBSVolumeConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html) . 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 parameter triggers a new service deployment. > (structure) > > The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. > > name -> (string) [required] > > > The name of the volume. This value must match the volume name from the `Volume` object in the task definition. > > managedEBSVolume -> (structure) > > > The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. > > > encrypted -> (boolean) > > > > Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as `false` , the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the `Encrypted` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > kmsKeyId -> (string) > > > > The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the `KmsKeyId` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . For more information about encrypting Amazon EBS volumes attached to tasks, see [Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html) . > > > > #### WARNING > > > > Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails. > > > volumeType -> (string) > > > > The volume type. This parameter maps 1:1 with the `VolumeType` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide* . > > > > The following are the supported volume types. > > > > * General Purpose SSD: `gp2` |`gp3` > > > > * Provisioned IOPS SSD: `io1` |`io2` > > > > * Throughput Optimized HDD: `st1` > > > > * Cold HDD: `sc1` > > > > * Magnetic: `standard` > > > > #### NOTE > > > > The magnetic volume type is not supported on Fargate. > > > sizeInGiB -> (integer) > > > > The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the `Size` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > The following are the supported volume size values for each volume type. > > > > * `gp2` and `gp3` : 1-16,384 > > > > * `io1` and `io2` : 4-16,384 > > > > * `st1` and `sc1` : 125-16,384 > > > > * `standard` : 1-1,024 > > > snapshotId -> (string) > > > > The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service. You must specify either `snapshotId` or `sizeInGiB` in your volume configuration. This parameter maps 1:1 with the `SnapshotId` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > volumeInitializationRate -> (integer) > > > > The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a `snapshotId` . For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EBS User Guide* . > > > iops -> (integer) > > > > The number of I/O operations per second (IOPS). For `gp3` , `io1` , and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. > > > > The following are the supported values for each volume type. > > > > * `gp3` : 3,000 - 16,000 IOPS > > > > * `io1` : 100 - 64,000 IOPS > > > > * `io2` : 100 - 256,000 IOPS > > > > This parameter is required for `io1` and `io2` volume types. The default for `gp3` volumes is `3,000 IOPS` . This parameter is not supported for `st1` , `sc1` , or `standard` volume types. > > > > This parameter maps 1:1 with the `Iops` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > throughput -> (integer) > > > > The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the `Throughput` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > #### WARNING > > > > This parameter is only supported for the `gp3` volume type. > > > tagSpecifications -> (list) > > > > The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the `TagSpecifications.N` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > (structure) > > > > > The tag specifications of an Amazon EBS volume. > > > > > resourceType -> (string) [required] > > > > > > The type of volume resource. > > > > > > Possible values: > > > > > > * `volume` > > > > > tags -> (list) > > > > > > The tags applied to this Amazon EBS volume. `AmazonECSCreated` and `AmazonECSManaged` are reserved tags that can’t be used. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `50` > > > > > > (structure) > > > > > > > The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them. > > > > > > > The following basic restrictions apply to tags: > > > > > > > * Maximum number of tags per resource - 50 > > > > > > > * For each resource, each tag key must be unique, and each tag key can have only one value. > > > > > > > * Maximum key length - 128 Unicode characters in UTF-8 > > > > > > > * Maximum value length - 256 Unicode characters in UTF-8 > > > > > > > * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . \_ : / @. > > > > > > > * Tag keys and values are case-sensitive. > > > > > > > * Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. > > > > > > > key -> (string) > > > > > > > > One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values. > > > > > > > > Constraints: > > > > > > > > * min: `1` > > > > > > > > * max: `128` > > > > > > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` > > > > > > > value -> (string) > > > > > > > > The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key). > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `256` > > > > > > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` > > > > > propagateTags -> (string) > > > > > > Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a `SERVICE` specified in `ServiceVolumeConfiguration` . If no value is specified, the tags aren’t propagated. > > > > > > Possible values: > > > > > > * `TASK_DEFINITION` > > > > > > * `SERVICE` > > > > > > * `NONE` > > > roleArn -> (string) [required] > > > > The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed `AmazonECSInfrastructureRolePolicyForVolumes` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide* . > > > filesystemType -> (string) > > > > The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the tasks will fail to start. > > > > The available Linux filesystem types are `ext3` , `ext4` , and `xfs` . If no value is specified, the `xfs` filesystem type is used by default. > > > > The available Windows filesystem types are `NTFS` . > > > > Possible values: > > > > * `ext3` > > > > * `ext4` > > > > * `xfs` > > > > * `ntfs` JSON Syntax: ```json [ { "name": "string", "managedEBSVolume": { "encrypted": true|false, "kmsKeyId": "string", "volumeType": "string", "sizeInGiB": integer, "snapshotId": "string", "volumeInitializationRate": integer, "iops": integer, "throughput": integer, "tagSpecifications": [ { "resourceType": "volume", "tags": [ { "key": "string", "value": "string" } ... ], "propagateTags": "TASK_DEFINITION"|"SERVICE"|"NONE" } ... ], "roleArn": "string", "filesystemType": "ext3"|"ext4"|"xfs"|"ntfs" } } ... ] ``` `--vpc-lattice-configurations` (list) > An object representing the VPC Lattice configuration for the service being updated. > This parameter triggers a new service deployment. > (structure) > > The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to. > > roleArn -> (string) [required] > > > The ARN of the IAM role to associate with this VPC Lattice configuration. This is the Amazon ECS infrastructure IAM role that is used to manage your VPC Lattice infrastructure. > > targetGroupArn -> (string) [required] > > > The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to. > > portName -> (string) [required] > > > The name of the port mapping to register in the VPC Lattice target group. This is the name of the `portMapping` you defined in your task definition. > > advancedConfiguration -> (structure) > > > The advanced settings for VPC Lattice used in blue/green deployments. Specify the alternate target group and listener rules required for traffic shifting during blue/green deployments. For more information, see [Required resources for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-deployment-implementation.html) in the *Amazon Elastic Container Service Developer Guide* . > > > alternateTargetGroupArn -> (string) > > > > The Amazon Resource Name (ARN) of the alternate target group associated with the VPC Lattice Configuration for Amazon ECS blue/green deployments. > > > productionListenerRule -> (string) > > > > The Amazon Resource Name (ARN) that identifies the production listener rule or listener for routing production traffic. > > > testListenerRule -> (string) > > > > The Amazon Resource Name (ARN) that identifies the test listener rule or listener for routing test traffic. Shorthand Syntax: ``` roleArn=string,targetGroupArn=string,portName=string,advancedConfiguration={alternateTargetGroupArn=string,productionListenerRule=string,testListenerRule=string} ... ``` JSON Syntax: ```json [ { "roleArn": "string", "targetGroupArn": "string", "portName": "string", "advancedConfiguration": { "alternateTargetGroupArn": "string", "productionListenerRule": "string", "testListenerRule": "string" } } ... ] ``` `--gateway-connectors` (list) > The updated set of gateway connectors that connect the service to a gateway ingress path. A service supports no more than one gateway connector. > Constraints: > * min: `0` > * max: `1` > (structure) > > A gateway connector that attaches an Amazon ECS service to a gateway ingress path. The connector specifies the service port that receives gateway-managed ingress traffic, along with the health check and traffic filters that the gateway applies. A service can have at most one gateway connector. > > portName -> (string) [required] > > > The name of the service port that the gateway routes ingress traffic to. > > healthCheck -> (structure) > > > The health check that the gateway uses to determine whether the targets for this connector are healthy. > > > healthCheckProtocol -> (string) > > > > The protocol that the gateway uses to perform health checks. > > > > Valid values: > > > > * `HTTP` - Health checks are performed over HTTP. > > > > * `HTTPS` - Health checks are performed over HTTPS. > > > > Possible values: > > > > * `HTTP` > > > > * `HTTPS` > > > healthCheckPort -> (integer) > > > > The port that the gateway uses to perform health checks on the targets. > > > healthCheckPath -> (string) > > > > The destination path for health check requests. > > > healthCheckTimeoutSeconds -> (integer) > > > > The amount of time, in seconds, during which no response from a target means a failed health check. > > > healthCheckIntervalSeconds -> (integer) > > > > The approximate amount of time, in seconds, between health checks of an individual target. > > > healthyThresholdCount -> (integer) > > > > The number of consecutive successful health checks that a target must pass before the gateway considers it healthy. > > > unhealthyThresholdCount -> (integer) > > > > The number of consecutive failed health checks that a target must fail before the gateway considers it unhealthy. > > > matcher -> (structure) > > > > The HTTP or gRPC codes that indicate a successful health check response from a target. > > > > httpCode -> (string) > > > > > The HTTP codes that indicate a successful response from a target. > > > > grpcCode -> (string) > > > > > The gRPC codes that indicate a successful response from a target. > > filters -> (structure) > > > The filters that control which gateway ingress paths the connector applies to. > > > accessTypes -> (list) > > > > The access types of the gateway ingress paths that the connector applies to. > > > > The access type can be one of the following values: > > > > * `PUBLIC` - The ingress path is publicly accessible. > > > > * `PRIVATE` - The ingress path is only accessible privately. > > > > Constraints: > > > > * min: `0` > > > > * max: `2` > > > > (string) > > > > > Specifies whether a resource is publicly accessible from the internet or private to a VPC. > > > > > Possible values: > > > > > * `PUBLIC` > > > > > * `PRIVATE` Shorthand Syntax: ``` portName=string,healthCheck={healthCheckProtocol=string,healthCheckPort=integer,healthCheckPath=string,healthCheckTimeoutSeconds=integer,healthCheckIntervalSeconds=integer,healthyThresholdCount=integer,unhealthyThresholdCount=integer,matcher={httpCode=string,grpcCode=string}},filters={accessTypes=[string,string]} ... ``` JSON Syntax: ```json [ { "portName": "string", "healthCheck": { "healthCheckProtocol": "HTTP"|"HTTPS", "healthCheckPort": integer, "healthCheckPath": "string", "healthCheckTimeoutSeconds": integer, "healthCheckIntervalSeconds": integer, "healthyThresholdCount": integer, "unhealthyThresholdCount": integer, "matcher": { "httpCode": "string", "grpcCode": "string" } }, "filters": { "accessTypes": ["PUBLIC"|"PRIVATE", ...] } } ... ] ``` `--monitoring` (structure) > The optional monitoring configuration for the service, which defines the resolution for the service-level `CPUUtilization` and `MemoryUtilization` Amazon CloudWatch metrics. When not specified, Amazon ECS uses the default resolution of `60` seconds. > metricConfigurations -> (list) > > The list of metric configurations for the service monitoring. > > Constraints: > > * min: `0` > > * max: `5` > > (structure) > > > The configuration for a specific set of metrics to collect for a service. > > > metricNames -> (list) [required] > > > > The list of metric names to configure. The supported metric names are `CPUUtilization` and `MemoryUtilization` . > > > > Constraints: > > > > * min: `1` > > > > * max: `5` > > > > (string) > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `255` > > > resolutionSeconds -> (integer) [required] > > > > The resolution, in seconds, at which to collect the metrics. The valid values are `20` and `60` . > > > > Constraints: > > > > * min: `20` > > > > * max: `60` JSON Syntax: ```json { "metricConfigurations": [ { "metricNames": ["string", ...], "resolutionSeconds": integer } ... ] } ``` `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. `--generate-cli-skeleton` (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced `--help` (boolean) Display help for the command/subcommand. ## Examples #### NOTE To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information. Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* . **Example 1: To change the task definition used in a service** The following `update-service` example updates the `my-http-service` service to use the `amazon-ecs-sample` task definition. ```bash aws ecs update-service \ --cluster test \ --service my-http-service \ --task-definition amazon-ecs-sample ``` Output: ```json { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/test/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/test", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 2, "pendingCount": 0, "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:2", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/7419115625193919142", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:2", "desiredCount": 0, "pendingCount": 0, "runningCount": 0, "failedTasks": 0, "createdAt": "2025-02-21T13:26:02.734000-06:00", "updatedAt": "2025-02-21T13:26:02.734000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "IN_PROGRESS", "rolloutStateReason": "ECS deployment ecs-svc/7419115625193919142 in progress." }, { "id": "ecs-svc/1709597507655421668", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/old-amazon-ecs-sample:4", "desiredCount": 2, "pendingCount": 0, "runningCount": 2, "failedTasks": 0, "createdAt": "2025-01-24T11:13:07.621000-06:00", "updatedAt": "2025-02-02T16:11:30.838000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/1709597507655421668 completed." } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [ { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "createdAt": "2025-02-21T10:31:26.037000-06:00", "message": "(my-http-service) has reached a steady state." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "createdAt": "2025-02-21T04:31:22.703000-06:00", "message": "(my-http-service) has reached a steady state." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "createdAt": "2025-02-20T22:31:22.514000-06:00", "message": "(my-http-service) has reached a steady state." } ], "createdAt": "2024-10-30T17:12:43.218000-05:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "DISABLED" } } ``` For more information, see [Update an Amazon ECS service using the console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html) in the *Amazon ECS Developer Guide*. **Example 2: To change the number of tasks in a service** The following `update-service` example updates the desired task count of the service `my-http-service` from to 2. ```bash aws ecs update-service \ --cluster MyCluster \ --service my-http-service \ --desired-count 2 ``` Output: ```json { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 1, "pendingCount": 0, "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "LATEST", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/1976744184940610707", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition", "desiredCount": 1, "pendingCount": 0, "runningCount": 1, "failedTasks": 0, "createdAt": "2024-12-03T16:24:25.225000-05:00", "updatedAt": "2024-12-03T16:25:15.837000-05:00", "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/1976744184940610707 completed." } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [ { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "createdAt": "2024-12-30T13:24:07.345000-05:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "createdAt": "2024-12-30T12:32:21.600000-05:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "createdAt": "2024-12-08T19:26:10.367000-05:00", "message": "(service my-http-service) has reached a steady state." } ], "createdAt": "2024-12-03T16:24:25.225000-05:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/Admin", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "ENABLED" } } ``` For more information, see [Updating an Amazon ECS service using the console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html) in the *Amazon ECS Developer Guide*. **Example 3: To configure Amazon EBS volumes for attachment at service update** The following `update-service` example updates the service `my-http-service` to use Amazon EBS volumes. You must have an Amazon ECS infrastructure role configured with the `AmazonECSInfrastructureRolePolicyForVolumes` managed policy attached. You must also specify a task definition with the same volume name as in the `update-service` request and with `configuredAtLaunch` set to `true`. This example uses the `--cli-input-json` option and a JSON input file called `ebs.json`. ```bash aws ecs update-service \ --cli-input-json file://ebs.json ``` Contents of `ebs.json`: ```json { "cluster": "mycluster", "taskDefinition": "mytaskdef", "service": "my-http-service", "desiredCount": 2, "volumeConfigurations": [ { "name": "myEbsVolume", "managedEBSVolume": { "roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole", "volumeType": "gp3", "sizeInGiB": 100, "iops": 3000, "throughput": 125, "filesystemType": "ext4" } } ] } ``` Output: ```json { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 2, "pendingCount": 0, "launchType": "FARGATE", "platformVersion": "LATEST", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:1", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/2420458347226626275", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:1", "desiredCount": 0, "pendingCount": 0, "runningCount": 0, "failedTasks": 0, "createdAt": "2025-02-21T15:07:20.519000-06:00", "updatedAt": "2025-02-21T15:07:20.519000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "IN_PROGRESS", "rolloutStateReason": "ECS deployment ecs-svc/2420458347226626275 in progress.", "volumeConfigurations": [ { "name": "ebs-volume", "managedEBSVolume": { "volumeType": "gp3", "sizeInGiB": 100, "iops": 3000, "throughput": 125, "roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole", "filesystemType": "ext4" } } ] }, { "id": "ecs-svc/5191625155316533644", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:2", "desiredCount": 2, "pendingCount": 0, "runningCount": 2, "failedTasks": 0, "createdAt": "2025-02-21T14:54:48.862000-06:00", "updatedAt": "2025-02-21T14:57:22.502000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/5191625155316533644 completed." } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [ { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE77777", "createdAt": "2025-02-21T14:57:22.508000-06:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE88888", "createdAt": "2025-02-21T14:57:22.507000-06:00", "message": "(service my-http-service) (deployment ecs-svc/5191625155316533644) deployment completed." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE99999", "createdAt": "2025-02-21T14:55:32.833000-06:00", "message": "(service my-http-service) has started 1 tasks: (task fb9c8df512684aec92f3c57dc3f22361)." } ], "createdAt": "2025-02-21T14:54:48.862000-06:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "ENABLED" } } ``` For more information, see [Use Amazon EBS volumes with Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html) in the *Amazon ECS Developer Guide*. **Example 4: To update a service to no longer use Amazon EBS volumes** The following `update-service` example updates the service `my-http-service` to no longer use Amazon EBS volumes. You must specify a task definition revision with `configuredAtLaunch` set to `false`. ```bash aws ecs update-service \ --cluster mycluster \ --task-definition mytaskdef \ --service my-http-service \ --desired-count 2 \ --volume-configurations "[]" ``` Output: ```json { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 2, "pendingCount": 0, "launchType": "FARGATE", "platformVersion": "LATEST", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/7522791612543716777", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3", "desiredCount": 0, "pendingCount": 0, "runningCount": 0, "failedTasks": 0, "createdAt": "2025-02-21T15:25:38.598000-06:00", "updatedAt": "2025-02-21T15:25:38.598000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "IN_PROGRESS", "rolloutStateReason": "ECS deployment ecs-svc/7522791612543716777 in progress." }, { "id": "ecs-svc/2420458347226626275", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/myoldtaskdef:1", "desiredCount": 2, "pendingCount": 0, "runningCount": 2, "failedTasks": 0, "createdAt": "2025-02-21T15:07:20.519000-06:00", "updatedAt": "2025-02-21T15:10:59.955000-06:00", "launchType": "FARGATE", "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/2420458347226626275 completed.", "volumeConfigurations": [ { "name": "ebs-volume", "managedEBSVolume": { "volumeType": "gp3", "sizeInGiB": 100, "iops": 3000, "throughput": 125, "roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole", "filesystemType": "ext4" } } ] } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [ { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "createdAt": "2025-02-21T15:10:59.959000-06:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "createdAt": "2025-02-21T15:10:59.958000-06:00", "message": "(service my-http-service) (deployment ecs-svc/2420458347226626275) deployment completed." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "createdAt": "2025-02-21T15:09:39.055000-06:00", "message": "(service my-http-service) has stopped 1 running tasks: (task fb9c8df512684aec92f3c57dc3f22361)." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "createdAt": "2025-02-21T15:08:57.653000-06:00", "message": "(service my-http-service) has stopped 1 running tasks: (task 33eff090ad2c40539daa837e6503a9bc)." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", "createdAt": "2025-02-21T15:08:15.631000-06:00", "message": "(service my-http-service) has started 1 tasks: (task 996c02a66ff24f3190a4a8e0c841740f)." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "createdAt": "2025-02-21T15:07:36.931000-06:00", "message": "(service my-http-service) has started 1 tasks: (task d5d23c39f89e46cf9a647b9cc6572feb)." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE77777", "createdAt": "2025-02-21T14:57:22.508000-06:00", "message": "(service my-http-service) has reached a steady state." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE88888", "createdAt": "2025-02-21T14:57:22.507000-06:00", "message": "(service my-http-service) (deployment ecs-svc/5191625155316533644) deployment completed." }, { "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE99999", "createdAt": "2025-02-21T14:55:32.833000-06:00", "message": "(service my-http-service) has started 1 tasks: (task fb9c8df512684aec92f3c57dc3f22361)." } ], "createdAt": "2025-02-21T14:54:48.862000-06:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-12344321" ], "securityGroups": [ "sg-12344321" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/AIDACKCEVSQ6C2EXAMPLE", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "ENABLED" } } ``` For more information, see [Use Amazon EBS volumes with Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html) in the *Amazon ECS Developer Guide*. **Example 5: To turn on Availability Zone rebalancing for a service** The following `update-service` example turns on Availability Zone rebalancing for the service `my-http-service`. ```bash aws ecs update-service \ --cluster MyCluster \ --service my-http-service \ --availability-zone-rebalancing ENABLED ``` Output: ```json { "service": { "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/my-http-service", "serviceName": "my-http-service", "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "loadBalancers": [], "serviceRegistries": [], "status": "ACTIVE", "desiredCount": 2, "runningCount": 1, "pendingCount": 0, "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "LATEST", "platformFamily": "Linux", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition", "deploymentConfiguration": { "deploymentCircuitBreaker": { "enable": true, "rollback": true }, "maximumPercent": 200, "minimumHealthyPercent": 100, "alarms": { "alarmNames": [], "rollback": false, "enable": false } }, "deployments": [ { "id": "ecs-svc/1976744184940610707", "status": "PRIMARY", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition", "desiredCount": 1, "pendingCount": 0, "runningCount": 1, "failedTasks": 0, "createdAt": "2024-12-03T16:24:25.225000-05:00", "updatedAt": "2024-12-03T16:25:15.837000-05:00", "capacityProviderStrategy": [ { "capacityProvider": "FARGATE", "weight": 1, "base": 0 } ], "platformVersion": "1.4.0", "platformFamily": "Linux", "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "rolloutState": "COMPLETED", "rolloutStateReason": "ECS deployment ecs-svc/1976744184940610707 completed." } ], "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", "events": [], "createdAt": "2024-12-03T16:24:25.225000-05:00", "placementConstraints": [], "placementStrategy": [], "networkConfiguration": { "awsvpcConfiguration": { "subnets": [ "subnet-0d0eab1bb38d5ca64", "subnet-0db5010045995c2d5" ], "securityGroups": [ "sg-02556bf85a191f59a" ], "assignPublicIp": "ENABLED" } }, "healthCheckGracePeriodSeconds": 0, "schedulingStrategy": "REPLICA", "deploymentController": { "type": "ECS" }, "createdBy": "arn:aws:iam::123456789012:role/Admin", "enableECSManagedTags": true, "propagateTags": "NONE", "enableExecuteCommand": false, "availabilityZoneRebalancing": "ENABLED" } } ``` For more information, see [Updating an Amazon ECS service using the console](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html) in the *Amazon ECS Developer Guide*. ## Output service -> (structure) > The full description of your service following the update call. > The response includes a `lifecycleHookDetails` field, which is an empty array when the service is created or updated. The values are populated when a lifecycle hook executes and are available as part of the service deployment details ([DescribeServiceDeployments](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServiceDeployments.html) ). > serviceArn -> (string) > > The ARN that identifies the service. For more information about the ARN format, see [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) in the *Amazon ECS Developer Guide* . > serviceName -> (string) > > The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions. > clusterArn -> (string) > > The Amazon Resource Name (ARN) of the cluster that hosts the service. > loadBalancers -> (list) > > 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. > > (structure) > > > The load balancer configuration to use with a service or task set. > > > When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers. > > > We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration. > > > A service-linked role is required for services that use multiple target groups. For more information, see [Using service-linked roles](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide* . > > > targetGroupArn -> (string) > > > > The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. > > > > A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. > > > > For services using the `ECS` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > For services using the `CODE_DEPLOY` deployment controller, you’re required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > #### WARNING > > > > If your service’s task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance` . Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type. > > > loadBalancerName -> (string) > > > > The name of the load balancer to associate with the Amazon ECS service or task set. > > > > If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted. > > > containerName -> (string) > > > > The name of the container (as it appears in a container definition) to associate with the load balancer. > > > > You need to specify the container name when configuring the target group for an Amazon ECS load balancer. > > > containerPort -> (integer) > > > > The port on the container to associate with the load balancer. This port must correspond to a `containerPort` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they’re launched on must allow ingress traffic on the `hostPort` of the port mapping. > > > advancedConfiguration -> (structure) > > > > The advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments. > > > > alternateTargetGroupArn -> (string) > > > > > The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments. > > > > productionListenerRule -> (string) > > > > > The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic. > > > > testListenerRule -> (string) > > > > > The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic. > > > > roleArn -> (string) > > > > > The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you. > serviceRegistries -> (list) > > The details for the service discovery registries to assign to this service. For more information, see [Service Discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) . > > (structure) > > > The details for the service registry. > > > Each service may be associated with one service registry. Multiple service registries for each service are not supported. > > > When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration. > > > registryArn -> (string) > > > > The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html) . > > > port -> (integer) > > > > The port value used if your service discovery service specified an SRV record. This field might be used if both the `awsvpc` network mode and SRV records are used. > > > containerName -> (string) > > > > The container name value to be used for your service discovery service. It’s already specified in the task definition. If the task definition that your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition that your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can’t specify both. > > > containerPort -> (integer) > > > > The port value to be used for your service discovery service. It’s already specified in the task definition. If the task definition your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can’t specify both. > status -> (string) > > The status of the service. The valid values are `ACTIVE` , `DRAINING` , or `INACTIVE` . > desiredCount -> (integer) > > The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) , and it can be modified with [UpdateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html) . > runningCount -> (integer) > > The number of tasks in the cluster that are in the `RUNNING` state. > pendingCount -> (integer) > > The number of tasks in the cluster that are in the `PENDING` state. > launchType -> (string) > > The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy. > > Possible values: > > * `EC2` > > * `FARGATE` > > * `EXTERNAL` > > * `MANAGED_INSTANCES` > capacityProviderStrategy -> (list) > > The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type. > > (structure) > > > The details of a capacity provider strategy. A capacity provider strategy can be set when using the [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) or [CreateCluster](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html) APIs or as the default capacity provider strategy for a cluster with the `CreateCluster` API. > > > Only capacity providers that are already associated with a cluster and have an `ACTIVE` or `UPDATING` status can be used in a capacity provider strategy. The [PutClusterCapacityProviders](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html) API is used to associate a capacity provider with a cluster. > > > If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the [CreateClusterCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html) API operation. > > > To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy. > > > With `FARGATE_SPOT` , you can run interruption tolerant tasks at a rate that’s discounted compared to the `FARGATE` price. `FARGATE_SPOT` runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. `FARGATE_SPOT` supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. `FARGATE_SPOT` supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later. > > > A capacity provider strategy can contain a maximum of 20 capacity providers. > > > capacityProvider -> (string) [required] > > > > The short name of the capacity provider. > > > weight -> (integer) > > > > The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The `weight` value is taken into consideration after the `base` value, if defined, is satisfied. > > > > If no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can’t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0` , any `RunTask` or `CreateService` actions using the capacity provider strategy will fail. > > > > Weight value characteristics: > > > > * Weight is considered after the base value is satisfied > > > > * The default value is `0` if not specified > > > > * The valid range is 0 to 1,000 > > > > * At least one capacity provider must have a weight greater than zero > > > > * Capacity providers with weight of `0` cannot place tasks > > > > Task distribution logic: > > > > * Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider > > > > * Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios > > > > Examples: > > > > Equal Distribution: Two capacity providers both with weight `1` will split tasks evenly after base requirements are met. > > > > Weighted Distribution: If capacityProviderA has weight `1` and capacityProviderB has weight `4` , then for every 1 task on A, 4 tasks will run on B. > > > > Constraints: > > > > * min: `0` > > > > * max: `1000` > > > base -> (integer) > > > > The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of `0` is used. > > > > Base value characteristics: > > > > * Only one capacity provider in a strategy can have a base defined > > > > * The default value is `0` if not specified > > > > * The valid range is 0 to 100,000 > > > > * Base requirements are satisfied first before weight distribution > > > > Constraints: > > > > * min: `0` > > > > * max: `100000` > platformVersion -> (string) > > The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn’t specified, the `LATEST` platform version is used. For more information, see [Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* . > platformFamily -> (string) > > The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type. > > All tasks that run as part of this service must use the same `platformFamily` value as the service (for example, `LINUX` ). > taskDefinition -> (string) > > The task definition to use for tasks in the service. This value is specified when the service is created with [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) , and it can be modified with [UpdateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html) . > deploymentConfiguration -> (structure) > > Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. > > deploymentCircuitBreaker -> (structure) > > > #### NOTE > > > The deployment circuit breaker can only be used for services using the rolling update (`ECS` ) deployment type. > > > The **deployment circuit breaker** determines whether a service deployment will fail if the service can’t reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* > > > enable -> (boolean) [required] > > > > Determines whether to use the deployment circuit breaker logic for the service. > > > rollback -> (boolean) [required] > > > > Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. > > > resetOnHealthyTask -> (boolean) > > > > Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to `true` , a task that reaches a healthy state resets the failure count to `0` . When set to `false` , Amazon ECS does not reset the failure count. The default is `true` . > > > thresholdConfiguration -> (structure) > > > > The threshold configuration that controls when the deployment circuit breaker triggers. The `type` and `value` together determine how many task failures are tolerated before the circuit breaker activates. > > > > type -> (string) [required] > > > > > Determines how Amazon ECS uses `value` to calculate the failure threshold. For the percentage types (`BOUNDED_PERCENT` and `UNBOUNDED_PERCENT` ), Amazon ECS multiplies `value` by the latest service desired count. For `COUNT` , Amazon ECS uses `value` directly as the threshold. The default is `BOUNDED_PERCENT` . > > > > > Possible values: > > > > > * `COUNT` > > > > > * `BOUNDED_PERCENT` > > > > > * `UNBOUNDED_PERCENT` > > > > value -> (integer) [required] > > > > > Specifies the integer that Amazon ECS uses to calculate the failure threshold. When `type` is `COUNT` , this value is the failure threshold itself. When `type` is a percentage type, Amazon ECS multiplies this value by the latest service desired count to produce the failure threshold. The default is `50` . > > maximumPercent -> (integer) > > > If a service is using the rolling update (`ECS` ) deployment type, the `maximumPercent` parameter represents an upper limit on the number of your service’s tasks that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the `desiredCount` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the `REPLICA` service scheduler and has a `desiredCount` of four tasks and a `maximumPercent` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default `maximumPercent` value for a service using the `REPLICA` service scheduler is 200%. > > > The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting replacement tasks first and then stopping the unhealthy tasks, as long as cluster resources for starting replacement tasks are available. For more information about how the scheduler replaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) . > > > If a service is using either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types, and tasks in the service use the EC2 launch type, the **maximum percent** value is set to the default value. The **maximum percent** value is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state. > > > #### NOTE > > > You can’t specify a custom `maximumPercent` value for a service that uses either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types and has tasks that use the EC2 launch type. > > > If the service uses either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types, and the tasks in the service use the Fargate launch type, the maximum percent value is not used. The value is still returned when describing your service. > > minimumHealthyPercent -> (integer) > > > If a service is using the rolling update (`ECS` ) deployment type, the `minimumHealthyPercent` represents a lower limit on the number of your service’s tasks that must remain in the `RUNNING` state during a deployment, as a percentage of the `desiredCount` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a `desiredCount` of four tasks and a `minimumHealthyPercent` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. > > > If any tasks are unhealthy and if `maximumPercent` doesn’t allow the Amazon ECS scheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one — using the `minimumHealthyPercent` as a constraint — to clear up capacity to launch replacement tasks. For more information about how the scheduler replaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) . > > > For services that *do not* use a load balancer, the following should be noted: > > > * A service is considered healthy if all essential containers within the tasks in the service pass their health checks. > > > * If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a `RUNNING` state before the task is counted towards the minimum healthy percent total. > > > * If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. > > > For services that *do* use a load balancer, the following should be noted: > > > * If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. > > > * If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. > > > The default value for a replica service for `minimumHealthyPercent` is 100%. The default `minimumHealthyPercent` value for a service using the `DAEMON` service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console. > > > The minimum number of healthy tasks during a deployment is the `desiredCount` multiplied by the `minimumHealthyPercent` /100, rounded up to the nearest integer value. > > > If a service is using either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types and is running tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value. The **minimum healthy percent** value is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state. > > > #### NOTE > > > You can’t specify a custom `minimumHealthyPercent` value for a service that uses either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types and has tasks that use the EC2 launch type. > > > If a service is using either the blue/green (`CODE_DEPLOY` ) or `EXTERNAL` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service. > > alarms -> (structure) > > > Information about the CloudWatch alarms. > > > alarmNames -> (list) [required] > > > > One or more CloudWatch alarm names. Use a “,” to separate the alarms. > > > > (string) > > > rollback -> (boolean) [required] > > > > Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. > > > enable -> (boolean) [required] > > > > Determines whether to use the CloudWatch alarm option in the service deployment process. > > strategy -> (string) > > > The deployment strategy for the service. Choose from these valid values: > > > * `ROLLING` - When you create a service which uses the rolling update (`ROLLING` ) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. > > > * `BLUE_GREEN` - A blue/green deployment strategy (`BLUE_GREEN` ) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed. > > > * `LINEAR` - A *linear* deployment strategy (`LINEAR` ) gradually shifts traffic from the current production environment to a new environment in equal percentages over time. With Amazon ECS linear deployments, you can control the pace of traffic shifting and validate new service revisions with increasing amounts of production traffic. > > > * `CANARY` - A *canary* deployment strategy (`CANARY` ) shifts a small percentage of traffic to the new service revision first, then shifts the remaining traffic all at once after a specified time period. This allows you to test the new version with a subset of users before full deployment. > > > Possible values: > > > * `ROLLING` > > > * `BLUE_GREEN` > > > * `LINEAR` > > > * `CANARY` > > bakeTimeInMinutes -> (integer) > > > The time period when both blue and green service revisions are running simultaneously after the production traffic has shifted. > > > You must provide this parameter when you use the `BLUE_GREEN` deployment strategy. > > lifecycleHooks -> (list) > > > An array of deployment lifecycle hook objects to run custom logic or pause the deployment at specific stages of the deployment lifecycle. > > > (structure) > > > > A deployment lifecycle hook runs custom logic or pauses the deployment at specific stages of the deployment process. You can use Lambda functions or pause hooks as hook targets. > > > > For more information, see [Lifecycle hooks for Amazon ECS service deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-lifecycle-hooks.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > targetType -> (string) > > > > > The type of action the lifecycle hook performs. Valid values are: > > > > > * `AWS_LAMBDA` - Invokes a Lambda function at the specified lifecycle stage. This is the default value. > > > > > * `PAUSE` - Pauses the deployment at the specified lifecycle stage until you call `ContinueServiceDeployment` to continue or roll back. > > > > > This field is optional. If not specified, the default value is `AWS_LAMBDA` . > > > > > Possible values: > > > > > * `AWS_LAMBDA` > > > > > * `PAUSE` > > > > hookTargetArn -> (string) > > > > > The Amazon Resource Name (ARN) of the hook target. For `AWS_LAMBDA` hooks, this is the Lambda function ARN. This field is not applicable for `PAUSE` hooks. > > > > > You must provide this parameter when configuring an `AWS_LAMBDA` lifecycle hook. > > > > roleArn -> (string) > > > > > The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf. > > > > > For more information, see [Permissions required for Lambda functions in Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-permissions.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > lifecycleStages -> (list) > > > > > The lifecycle stages at which to run the hook. Choose from these valid values: > > > > > * RECONCILE_SERVICE The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state. You can use a lifecycle hook for this stage. > > > > > * PRE_SCALE_UP The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic. You can use a lifecycle hook for this stage. > > > > > * POST_SCALE_UP The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic. You can use a lifecycle hook for this stage. > > > > > * TEST_TRAFFIC_SHIFT The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic. You can use a lifecycle hook for this stage. > > > > > * POST_TEST_TRAFFIC_SHIFT The test traffic shift is complete. The green service revision handles 100% of the test traffic. You can use a lifecycle hook for this stage. > > > > > * PRE_PRODUCTION_TRAFFIC_SHIFT Occurs before production traffic shift. For linear and canary deployments, this stage is invoked before every traffic shift step. You can use a lifecycle hook for this stage. > > > > > * PRODUCTION_TRAFFIC_SHIFT Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic. For linear and canary deployments, this stage is invoked at every traffic shift step. You can use a lifecycle hook for this stage. > > > > > * POST_PRODUCTION_TRAFFIC_SHIFT The production traffic shift is complete. You can use a lifecycle hook for this stage. > > > > > #### NOTE > > > > > `PAUSE` hooks cannot be configured at `TEST_TRAFFIC_SHIFT` or `PRODUCTION_TRAFFIC_SHIFT` stages. These stages are only valid for `AWS_LAMBDA` hooks. > > > > > You must provide this parameter when configuring a deployment lifecycle hook. > > > > > (string) > > > > > > Possible values: > > > > > > * `RECONCILE_SERVICE` > > > > > > * `PRE_SCALE_UP` > > > > > > * `POST_SCALE_UP` > > > > > > * `TEST_TRAFFIC_SHIFT` > > > > > > * `POST_TEST_TRAFFIC_SHIFT` > > > > > > * `PRE_PRODUCTION_TRAFFIC_SHIFT` > > > > > > * `PRODUCTION_TRAFFIC_SHIFT` > > > > > > * `POST_PRODUCTION_TRAFFIC_SHIFT` > > > > hookDetails -> (document) > > > > > Use this field to specify custom parameters that Amazon ECS passes to your Lambda function on each invocation. This field is not used for `PAUSE` hooks. > > > > timeoutConfiguration -> (structure) > > > > > The timeout configuration for the lifecycle hook. This specifies how long Amazon ECS waits before taking the timeout action if the hook is not resolved. > > > > > timeoutInMinutes -> (integer) > > > > > > The number of minutes Amazon ECS waits for the lifecycle hook to complete before taking the timeout action. > > > > > > Default: 1440 (24 hours) > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `20160` > > > > > action -> (string) > > > > > > The action Amazon ECS takes when the lifecycle hook times out. Valid values are: > > > > > > * `CONTINUE` - Proceeds the deployment to the next lifecycle stage. > > > > > > * `ROLLBACK` - Rolls back the deployment to the previous service revision. > > > > > > Default: `ROLLBACK` > > > > > > Possible values: > > > > > > * `ROLLBACK` > > > > > > * `CONTINUE` > > linearConfiguration -> (structure) > > > Configuration for linear deployment strategy. Only valid when the deployment strategy is `LINEAR` . This configuration enables progressive traffic shifting in equal percentage increments with configurable bake times between each step. > > > stepPercent -> (double) > > > > The percentage of production traffic to shift in each step during a linear deployment. Valid values are multiples of 0.1 from 3.0 to 100.0. The default value is 10.0. > > > stepBakeTimeInMinutes -> (integer) > > > > The amount of time in minutes to wait between each traffic shifting step during a linear deployment. Valid values are 0 to 1440 minutes (24 hours). The default value is 6. This bake time is not applied after reaching 100 percent traffic. > > canaryConfiguration -> (structure) > > > Configuration for canary deployment strategy. Only valid when the deployment strategy is `CANARY` . This configuration enables shifting a fixed percentage of traffic for testing, followed by shifting the remaining traffic after a bake period. > > > canaryPercent -> (double) > > > > The percentage of production traffic to shift to the new service revision during the canary phase. Valid values are multiples of 0.1 from 0.1 to 100.0. The default value is 5.0. > > > canaryBakeTimeInMinutes -> (integer) > > > > The amount of time in minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision. Valid values are 0 to 1440 minutes (24 hours). The default value is 10. > > earlySuccessCriteria -> (structure) > > > The early success criteria configuration for a rolling deployment. With early success criteria, you can configure an Amazon ECS deployment to complete faster. Amazon ECS declares a deployment successful once a target percentage of tasks are healthy, instead of waiting for the service to fully stabilize. > > > enable -> (boolean) [required] > > > > Specifies whether to use the early success criteria for the service deployment. When set to `false` , the deployment uses the default behavior, where Amazon ECS considers the deployment successful when the target service revision fully stabilizes and the previous tasks are removed. The default value is `false` . > > > > When set to `true` , Amazon ECS monitors the deployment to meet early success criteria. You must also specify `healthyPercent` and `sourceServiceRevisionCleanup` . > > > healthyPercent -> (integer) > > > > The percentage of healthy tasks that the target service revision must reach before Amazon ECS considers the deployment successful. This percentage is relative to the service’s `desiredCount` and must be an integer between `0` and `100` . This value must be greater than or equal to the `minimumHealthyPercent` value. > > > > After this percentage of tasks is healthy and the bake time elapses, Amazon ECS completes the deployment. Amazon ECS continues to scale the target service revision to 100 percent in the background. > > > > Constraints: > > > > * min: `0` > > > > * max: `100` > > > sourceServiceRevisionCleanup -> (string) > > > > The time when Amazon ECS removes the source revisions’ tasks relative to deployment completion. The valid values are: > > > > * `BLOCKING` —Amazon ECS removes the previous tasks before it marks the deployment as successful. > > > > * `DEFERRED` —Amazon ECS marks the deployment successful, and then removes the previous tasks in the background. > > > > Possible values: > > > > * `BLOCKING` > > > > * `DEFERRED` > taskSets -> (list) > > Information about a set of Amazon ECS tasks in either an CodeDeploy or an `EXTERNAL` deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. > > (structure) > > > Information about a set of Amazon ECS tasks in either an CodeDeploy or an `EXTERNAL` deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. > > > id -> (string) > > > > The ID of the task set. > > > taskSetArn -> (string) > > > > The Amazon Resource Name (ARN) of the task set. > > > serviceArn -> (string) > > > > The Amazon Resource Name (ARN) of the service the task set exists in. > > > clusterArn -> (string) > > > > The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in. > > > startedBy -> (string) > > > > The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the `startedBy` parameter is `CODE_DEPLOY` . If an external deployment created the task set, the `startedBy` field isn’t used. > > > externalId -> (string) > > > > The external ID associated with the task set. > > > > If an CodeDeploy deployment created a task set, the `externalId` parameter contains the CodeDeploy deployment ID. > > > > If a task set is created for an external deployment and is associated with a service discovery registry, the `externalId` parameter contains the `ECS_TASK_SET_EXTERNAL_ID` Cloud Map attribute. > > > status -> (string) > > > > The status of the task set. The following describes each state. > > > > > PRIMARY > > > > The task set is serving production traffic. > > > > > ACTIVE > > > > The task set isn’t serving production traffic. > > > > > DRAINING > > > > The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group. > > > taskDefinition -> (string) > > > > The task definition that the task set is using. > > > computedDesiredCount -> (integer) > > > > The computed desired count for the task set. This is calculated by multiplying the service’s `desiredCount` by the task set’s `scale` percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks. > > > pendingCount -> (integer) > > > > The number of tasks in the task set that are in the `PENDING` status during a deployment. A task in the `PENDING` state is preparing to enter the `RUNNING` state. A task set enters the `PENDING` status when it launches for the first time or when it’s restarted after being in the `STOPPED` state. > > > runningCount -> (integer) > > > > The number of tasks in the task set that are in the `RUNNING` status during a deployment. A task in the `RUNNING` state is running and ready for use. > > > createdAt -> (timestamp) > > > > The Unix timestamp for the time when the task set was created. > > > updatedAt -> (timestamp) > > > > The Unix timestamp for the time when the task set was last updated. > > > launchType -> (string) > > > > The launch type the tasks in the task set are using. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > Possible values: > > > > * `EC2` > > > > * `FARGATE` > > > > * `EXTERNAL` > > > > * `MANAGED_INSTANCES` > > > capacityProviderStrategy -> (list) > > > > The capacity provider strategy that are associated with the task set. > > > > (structure) > > > > > The details of a capacity provider strategy. A capacity provider strategy can be set when using the [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) or [CreateCluster](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html) APIs or as the default capacity provider strategy for a cluster with the `CreateCluster` API. > > > > > Only capacity providers that are already associated with a cluster and have an `ACTIVE` or `UPDATING` status can be used in a capacity provider strategy. The [PutClusterCapacityProviders](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html) API is used to associate a capacity provider with a cluster. > > > > > If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the [CreateClusterCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html) API operation. > > > > > To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy. > > > > > With `FARGATE_SPOT` , you can run interruption tolerant tasks at a rate that’s discounted compared to the `FARGATE` price. `FARGATE_SPOT` runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. `FARGATE_SPOT` supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. `FARGATE_SPOT` supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later. > > > > > A capacity provider strategy can contain a maximum of 20 capacity providers. > > > > > capacityProvider -> (string) [required] > > > > > > The short name of the capacity provider. > > > > > weight -> (integer) > > > > > > The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The `weight` value is taken into consideration after the `base` value, if defined, is satisfied. > > > > > > If no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can’t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0` , any `RunTask` or `CreateService` actions using the capacity provider strategy will fail. > > > > > > Weight value characteristics: > > > > > > * Weight is considered after the base value is satisfied > > > > > > * The default value is `0` if not specified > > > > > > * The valid range is 0 to 1,000 > > > > > > * At least one capacity provider must have a weight greater than zero > > > > > > * Capacity providers with weight of `0` cannot place tasks > > > > > > Task distribution logic: > > > > > > * Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider > > > > > > * Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios > > > > > > Examples: > > > > > > Equal Distribution: Two capacity providers both with weight `1` will split tasks evenly after base requirements are met. > > > > > > Weighted Distribution: If capacityProviderA has weight `1` and capacityProviderB has weight `4` , then for every 1 task on A, 4 tasks will run on B. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1000` > > > > > base -> (integer) > > > > > > The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of `0` is used. > > > > > > Base value characteristics: > > > > > > * Only one capacity provider in a strategy can have a base defined > > > > > > * The default value is `0` if not specified > > > > > > * The valid range is 0 to 100,000 > > > > > > * Base requirements are satisfied first before weight distribution > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `100000` > > > platformVersion -> (string) > > > > The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see [Fargate platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* . > > > platformFamily -> (string) > > > > The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type. > > > > All tasks in the set must have the same value. > > > networkConfiguration -> (structure) > > > > The network configuration for the task set. > > > > awsvpcConfiguration -> (structure) > > > > > The VPC subnets and security groups that are associated with a task. > > > > > #### NOTE > > > > > All specified subnets and security groups must be from the same VPC. > > > > > subnets -> (list) [required] > > > > > > The IDs of the subnets associated with the task or service. There’s a limit of 16 subnets that can be specified. > > > > > > #### NOTE > > > > > > All specified subnets must be from the same VPC. > > > > > > (string) > > > > > securityGroups -> (list) > > > > > > The IDs of the security groups associated with the task or service. If you don’t specify a security group, the default security group for the VPC is used. There’s a limit of 5 security groups that can be specified. > > > > > > #### NOTE > > > > > > All specified security groups must be from the same VPC. > > > > > > (string) > > > > > assignPublicIp -> (string) > > > > > > Whether the task’s elastic network interface receives a public IP address. > > > > > > Consider the following when you set this value: > > > > > > * When you use `create-service` or `update-service` , the default is `DISABLED` . > > > > > > * When the service `deploymentController` is `ECS` , the value must be `DISABLED` . > > > > > > Possible values: > > > > > > * `ENABLED` > > > > > > * `DISABLED` > > > loadBalancers -> (list) > > > > Details on a load balancer that are used with a task set. > > > > (structure) > > > > > The load balancer configuration to use with a service or task set. > > > > > When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load balancers. > > > > > We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration. > > > > > A service-linked role is required for services that use multiple target groups. For more information, see [Using service-linked roles](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > targetGroupArn -> (string) > > > > > > The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. > > > > > > A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. > > > > > > For services using the `ECS` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > For services using the `CODE_DEPLOY` deployment controller, you’re required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > #### WARNING > > > > > > If your service’s task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance` . Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type. > > > > > loadBalancerName -> (string) > > > > > > The name of the load balancer to associate with the Amazon ECS service or task set. > > > > > > If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted. > > > > > containerName -> (string) > > > > > > The name of the container (as it appears in a container definition) to associate with the load balancer. > > > > > > You need to specify the container name when configuring the target group for an Amazon ECS load balancer. > > > > > containerPort -> (integer) > > > > > > The port on the container to associate with the load balancer. This port must correspond to a `containerPort` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they’re launched on must allow ingress traffic on the `hostPort` of the port mapping. > > > > > advancedConfiguration -> (structure) > > > > > > The advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments. > > > > > > alternateTargetGroupArn -> (string) > > > > > > > The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments. > > > > > > productionListenerRule -> (string) > > > > > > > The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic. > > > > > > testListenerRule -> (string) > > > > > > > The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic. > > > > > > roleArn -> (string) > > > > > > > The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you. > > > serviceRegistries -> (list) > > > > The details for the service discovery registries to assign to this task set. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) . > > > > (structure) > > > > > The details for the service registry. > > > > > Each service may be associated with one service registry. Multiple service registries for each service are not supported. > > > > > When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration. > > > > > registryArn -> (string) > > > > > > The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html) . > > > > > port -> (integer) > > > > > > The port value used if your service discovery service specified an SRV record. This field might be used if both the `awsvpc` network mode and SRV records are used. > > > > > containerName -> (string) > > > > > > The container name value to be used for your service discovery service. It’s already specified in the task definition. If the task definition that your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition that your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can’t specify both. > > > > > containerPort -> (integer) > > > > > > The port value to be used for your service discovery service. It’s already specified in the task definition. If the task definition your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition. If the task definition your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value. However, you can’t specify both. > > > scale -> (structure) > > > > A floating-point percentage of your desired number of tasks to place and keep running in the task set. > > > > value -> (double) > > > > > The value, specified as a percent total of a service’s `desiredCount` , to scale the task set. Accepted values are numbers between 0 and 100. > > > > unit -> (string) > > > > > The unit of measure for the scale value. > > > > > Possible values: > > > > > * `PERCENT` > > > stabilityStatus -> (string) > > > > The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in `STEADY_STATE` : > > > > * The task `runningCount` is equal to the `computedDesiredCount` . > > > > * The `pendingCount` is `0` . > > > > * There are no tasks that are running on container instances in the `DRAINING` status. > > > > * All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks. > > > > If any of those conditions aren’t met, the stability status returns `STABILIZING` . > > > > Possible values: > > > > * `STEADY_STATE` > > > > * `STABILIZING` > > > stabilityStatusAt -> (timestamp) > > > > The Unix timestamp for the time when the task set stability status was retrieved. > > > tags -> (list) > > > > The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. > > > > The following basic restrictions apply to tags: > > > > * Maximum number of tags per resource - 50 > > > > * For each resource, each tag key must be unique, and each tag key can have only one value. > > > > * Maximum key length - 128 Unicode characters in UTF-8 > > > > * Maximum value length - 256 Unicode characters in UTF-8 > > > > * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . \_ : / @. > > > > * Tag keys and values are case-sensitive. > > > > * Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. > > > > Constraints: > > > > * min: `0` > > > > * max: `50` > > > > (structure) > > > > > The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them. > > > > > The following basic restrictions apply to tags: > > > > > * Maximum number of tags per resource - 50 > > > > > * For each resource, each tag key must be unique, and each tag key can have only one value. > > > > > * Maximum key length - 128 Unicode characters in UTF-8 > > > > > * Maximum value length - 256 Unicode characters in UTF-8 > > > > > * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . \_ : / @. > > > > > * Tag keys and values are case-sensitive. > > > > > * Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. > > > > > key -> (string) > > > > > > One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `128` > > > > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` > > > > > value -> (string) > > > > > > The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key). > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `256` > > > > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` > > > fargateEphemeralStorage -> (structure) > > > > The Fargate ephemeral storage settings for the task set. > > > > kmsKeyId -> (string) > > > > > Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment. > deployments -> (list) > > The current state of deployments for the service. > > (structure) > > > The details of an Amazon ECS service deployment. This is used only when a service uses the `ECS` deployment controller type. > > > id -> (string) > > > > The ID of the deployment. > > > status -> (string) > > > > The status of the deployment. The following describes each state. > > > > > PRIMARY > > > > The most recent deployment of a service. > > > > > ACTIVE > > > > A service deployment that still has running tasks, but are in the process of being replaced with a new `PRIMARY` deployment. > > > > > INACTIVE > > > > A deployment that has been completely replaced. > > > taskDefinition -> (string) > > > > The most recent task definition that was specified for the tasks in the service to use. > > > desiredCount -> (integer) > > > > The most recent desired count of tasks that was specified for the service to deploy or maintain. > > > pendingCount -> (integer) > > > > The number of tasks in the deployment that are in the `PENDING` status. > > > runningCount -> (integer) > > > > The number of tasks in the deployment that are in the `RUNNING` status. > > > failedTasks -> (integer) > > > > The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can’t launch the task, the task doesn’t transition to a `RUNNING` state, or if it fails any of its defined health checks and is stopped. > > > > #### NOTE > > > > Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated. > > > createdAt -> (timestamp) > > > > The Unix timestamp for the time when the service deployment was created. > > > updatedAt -> (timestamp) > > > > The Unix timestamp for the time when the service deployment was last updated. > > > capacityProviderStrategy -> (list) > > > > The capacity provider strategy that the deployment is using. > > > > (structure) > > > > > The details of a capacity provider strategy. A capacity provider strategy can be set when using the [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) or [CreateCluster](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html) APIs or as the default capacity provider strategy for a cluster with the `CreateCluster` API. > > > > > Only capacity providers that are already associated with a cluster and have an `ACTIVE` or `UPDATING` status can be used in a capacity provider strategy. The [PutClusterCapacityProviders](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html) API is used to associate a capacity provider with a cluster. > > > > > If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the [CreateClusterCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html) API operation. > > > > > To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy. > > > > > With `FARGATE_SPOT` , you can run interruption tolerant tasks at a rate that’s discounted compared to the `FARGATE` price. `FARGATE_SPOT` runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. `FARGATE_SPOT` supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. `FARGATE_SPOT` supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later. > > > > > A capacity provider strategy can contain a maximum of 20 capacity providers. > > > > > capacityProvider -> (string) [required] > > > > > > The short name of the capacity provider. > > > > > weight -> (integer) > > > > > > The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The `weight` value is taken into consideration after the `base` value, if defined, is satisfied. > > > > > > If no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can’t be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0` , any `RunTask` or `CreateService` actions using the capacity provider strategy will fail. > > > > > > Weight value characteristics: > > > > > > * Weight is considered after the base value is satisfied > > > > > > * The default value is `0` if not specified > > > > > > * The valid range is 0 to 1,000 > > > > > > * At least one capacity provider must have a weight greater than zero > > > > > > * Capacity providers with weight of `0` cannot place tasks > > > > > > Task distribution logic: > > > > > > * Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider > > > > > > * Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios > > > > > > Examples: > > > > > > Equal Distribution: Two capacity providers both with weight `1` will split tasks evenly after base requirements are met. > > > > > > Weighted Distribution: If capacityProviderA has weight `1` and capacityProviderB has weight `4` , then for every 1 task on A, 4 tasks will run on B. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1000` > > > > > base -> (integer) > > > > > > The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of `0` is used. > > > > > > Base value characteristics: > > > > > > * Only one capacity provider in a strategy can have a base defined > > > > > > * The default value is `0` if not specified > > > > > > * The valid range is 0 to 100,000 > > > > > > * Base requirements are satisfied first before weight distribution > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `100000` > > > launchType -> (string) > > > > The launch type the tasks in the service are using. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > Possible values: > > > > * `EC2` > > > > * `FARGATE` > > > > * `EXTERNAL` > > > > * `MANAGED_INSTANCES` > > > platformVersion -> (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 one isn’t specified, the `LATEST` platform version is used. For more information, see [Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* . > > > platformFamily -> (string) > > > > The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type. > > > > All tasks that run as part of this service must use the same `platformFamily` value as the service, for example, `LINUX.` . > > > networkConfiguration -> (structure) > > > > The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the `awsvpc` networking mode. > > > > awsvpcConfiguration -> (structure) > > > > > The VPC subnets and security groups that are associated with a task. > > > > > #### NOTE > > > > > All specified subnets and security groups must be from the same VPC. > > > > > subnets -> (list) [required] > > > > > > The IDs of the subnets associated with the task or service. There’s a limit of 16 subnets that can be specified. > > > > > > #### NOTE > > > > > > All specified subnets must be from the same VPC. > > > > > > (string) > > > > > securityGroups -> (list) > > > > > > The IDs of the security groups associated with the task or service. If you don’t specify a security group, the default security group for the VPC is used. There’s a limit of 5 security groups that can be specified. > > > > > > #### NOTE > > > > > > All specified security groups must be from the same VPC. > > > > > > (string) > > > > > assignPublicIp -> (string) > > > > > > Whether the task’s elastic network interface receives a public IP address. > > > > > > Consider the following when you set this value: > > > > > > * When you use `create-service` or `update-service` , the default is `DISABLED` . > > > > > > * When the service `deploymentController` is `ECS` , the value must be `DISABLED` . > > > > > > Possible values: > > > > > > * `ENABLED` > > > > > > * `DISABLED` > > > rolloutState -> (string) > > > > #### NOTE > > > > The `rolloutState` of a service is only returned for services that use the rolling update (`ECS` ) deployment type that aren’t behind a Classic Load Balancer. > > > > The rollout state of the deployment. When a service deployment is started, it begins in an `IN_PROGRESS` state. When the service reaches a steady state, the deployment transitions to a `COMPLETED` state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a `FAILED` state. A deployment in `FAILED` state doesn’t launch any new tasks. For more information, see [DeploymentCircuitBreaker](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentCircuitBreaker.html) . > > > > Possible values: > > > > * `COMPLETED` > > > > * `FAILED` > > > > * `IN_PROGRESS` > > > rolloutStateReason -> (string) > > > > A description of the rollout state of a deployment. > > > serviceConnectConfiguration -> (structure) > > > > The details of the Service Connect configuration that’s used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments. > > > > 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > enabled -> (boolean) [required] > > > > > Specifies whether to use Service Connect with this service. > > > > namespace -> (string) > > > > > The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn’t affect Service Connect. For more information about Cloud Map, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Cloud Map Developer Guide* . > > > > services -> (list) > > > > > The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. > > > > > This field is not required for a “client” Amazon ECS service that’s a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that’s attached to the service or by other means. > > > > > An object selects a port from the task definition, assigns a name for the Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service. > > > > > (structure) > > > > > > The Service Connect service object configuration. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > portName -> (string) [required] > > > > > > > The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service. > > > > > > discoveryName -> (string) > > > > > > > The `discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can’t start with a hyphen. > > > > > > > If the `discoveryName` isn’t specified, the port mapping name from the task definition is used in `portName.namespace` . > > > > > > clientAliases -> (list) > > > > > > > The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. > > > > > > > Each alias (“endpoint”) is a fully-qualified name and port number that other Amazon ECS tasks (“clients”) can use to connect to this service. > > > > > > > Each name and port mapping must be unique within the namespace. > > > > > > > For each `ServiceConnectService` , you must provide at least one `clientAlias` with one `port` . > > > > > > > (structure) > > > > > > > > Each alias (“endpoint”) is a fully-qualified name and port number that other tasks (“clients”) can use to connect to this service. > > > > > > > > Each name and port mapping must be unique within the 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > > > port -> (integer) [required] > > > > > > > > > The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. > > > > > > > > > To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > > > > Constraints: > > > > > > > > > * min: `0` > > > > > > > > > * max: `65535` > > > > > > > > dnsName -> (string) > > > > > > > > > The `dnsName` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn’t need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can’t start with a hyphen. > > > > > > > > > If this parameter isn’t specified, the default value of `discoveryName.namespace` is used. If the `discoveryName` isn’t specified, the port mapping name from the task definition is used in `portName.namespace` . > > > > > > > > > To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are `database` , `db` , or the lowercase name of a database, such as `mysql` or `redis` . For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > > > testTrafficRules -> (structure) > > > > > > > > > The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic. > > > > > > > > > header -> (structure) [required] > > > > > > > > > > The HTTP header-based routing rules that determine which requests should be routed to the new service version during blue/green deployment testing. These rules provide fine-grained control over test traffic routing based on request headers. > > > > > > > > > > name -> (string) [required] > > > > > > > > > > > The name of the HTTP header to examine for test traffic routing. Common examples include custom headers like `X-Test-Version` or `X-Canary-Request` that can be used to identify test traffic. > > > > > > > > > > value -> (structure) > > > > > > > > > > > The header value matching configuration that determines how the HTTP header value is evaluated for test traffic routing decisions. > > > > > > > > > > > exact -> (string) [required] > > > > > > > > > > > > The exact value that the HTTP header must match for the test traffic routing rule to apply. This provides precise control over which requests are routed to the new service revision during blue/green deployments. > > > > > > ingressPortOverride -> (integer) > > > > > > > The port number for the Service Connect proxy to listen on. > > > > > > > Use the value of this field to bypass the proxy for traffic on the port number specified in the named `portMapping` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. > > > > > > > In `awsvpc` mode and Fargate, the default value is the container port number. The container port number is in the `portMapping` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy. > > > > > > > Constraints: > > > > > > > * min: `0` > > > > > > > * max: `65535` > > > > > > timeout -> (structure) > > > > > > > A reference to an object that represents the configured timeouts for Service Connect. > > > > > > > idleTimeoutSeconds -> (integer) > > > > > > > > The amount of time in seconds a connection will stay active while idle. A value of `0` can be set to disable `idleTimeout` . > > > > > > > > The `idleTimeout` default for `HTTP` /`HTTP2` /`GRPC` is 5 minutes. > > > > > > > > The `idleTimeout` default for `TCP` is 1 hour. > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `2147483647` > > > > > > > perRequestTimeoutSeconds -> (integer) > > > > > > > > The amount of time waiting for the upstream to respond with a complete response per request. A value of `0` can be set to disable `perRequestTimeout` . `perRequestTimeout` can only be set if Service Connect `appProtocol` isn’t `TCP` . Only `idleTimeout` is allowed for `TCP` `appProtocol` . > > > > > > > > Constraints: > > > > > > > > * min: `0` > > > > > > > > * max: `2147483647` > > > > > > tls -> (structure) > > > > > > > A reference to an object that represents a Transport Layer Security (TLS) configuration. > > > > > > > issuerCertificateAuthority -> (structure) [required] > > > > > > > > The signer certificate authority. > > > > > > > > awsPcaAuthorityArn -> (string) > > > > > > > > > The ARN of the Amazon Web Services Private Certificate Authority certificate. > > > > > > > kmsKey -> (string) > > > > > > > > The Amazon Web Services Key Management Service key. > > > > > > > roleArn -> (string) > > > > > > > > The Amazon Resource Name (ARN) of the IAM role that’s associated with the Service Connect TLS. > > > > logConfiguration -> (structure) > > > > > The log configuration for the container. This parameter maps to `LogConfig` in the docker container create command and the `--log-driver` option to docker run. > > > > > By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. > > > > > Understand the following when specifying a log configuration for your containers. > > > > > * Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on Fargate, the supported log drivers are `awslogs` , `splunk` , and `awsfirelens` . For tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs` , `fluentd` , `gelf` , `json-file` , `journald` ,\`\`syslog\`\` , `splunk` , and `awsfirelens` . For tasks on Amazon ECS Managed Instances, the supported log drivers are `awslogs` , `splunk` , `awsfirelens` , and `json-file` . > > > > > * This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. > > > > > * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > * For tasks that are on Fargate, because you don’t have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. > > > > > logDriver -> (string) [required] > > > > > > The log driver to use for the container. > > > > > > For tasks on Fargate, the supported log drivers are `awslogs` , `splunk` , and `awsfirelens` . > > > > > > For tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs` , `fluentd` , `gelf` , `json-file` , `journald` , `syslog` , `splunk` , and `awsfirelens` . > > > > > > For tasks on Amazon ECS Managed Instances, the supported log drivers are `awslogs` , `splunk` , `awsfirelens` , and `json-file` . > > > > > > For more information about using the `awslogs` log driver, see [Send Amazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > For more information about using the `awsfirelens` log driver, see [Send Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) . > > > > > > #### NOTE > > > > > > If you have a custom driver that isn’t listed, you can fork the Amazon ECS container agent project that’s [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don’t currently provide support for running modified copies of this software. > > > > > > Possible values: > > > > > > * `json-file` > > > > > > * `syslog` > > > > > > * `journald` > > > > > > * `gelf` > > > > > > * `fluentd` > > > > > > * `awslogs` > > > > > > * `splunk` > > > > > > * `awsfirelens` > > > > > options -> (map) > > > > > > The configuration options to send to the log driver. > > > > > > The options you can specify depend on the log driver. Some of the options you can specify when you use the `awslogs` log driver to route logs to Amazon CloudWatch include the following: > > > > > > > awslogs-create-group > > > > > > Required: No > > > > > > Specify whether you want the log group to be created automatically. If this option isn’t specified, it defaults to `false` . > > > > > > #### NOTE > > > > > > Your IAM policy must include the `logs:CreateLogGroup` permission before you attempt to use `awslogs-create-group` . > > > > > > awslogs-region > > > > > > Required: Yes > > > > > > Specify the Amazon Web Services Region that the `awslogs` log driver is to send your Docker logs to. You can choose to send all of your logs from clusters in different Regions to a single region in CloudWatch Logs. This is so that they’re all visible in one location. Otherwise, you can separate them by Region for more granularity. Make sure that the specified log group exists in the Region that you specify with this option. > > > > > > > awslogs-group > > > > > > Required: Yes > > > > > > Make sure to specify a log group that the `awslogs` log driver sends its log streams to. > > > > > > > awslogs-stream-prefix > > > > > > Required: Yes, when using Fargate.Optional when using EC2. > > > > > > Use the `awslogs-stream-prefix` option to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task that the container belongs to. If you specify a prefix with this option, then the log stream takes the format `prefix-name/container-name/ecs-task-id` . > > > > > > If you don’t specify a prefix with this option, then the log stream is named after the container ID that’s assigned by the Docker daemon on the container instance. Because it’s difficult to trace logs back to the container that sent them with just the Docker container ID (which is only available on the container instance), we recommend that you specify a prefix with this option. > > > > > > For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace log streams to the service that the container belongs to, the name of the container that sent them, and the ID of the task that the container belongs to. > > > > > > You must specify a stream-prefix for your logs to have your logs appear in the Log pane when using the Amazon ECS console. > > > > > > > awslogs-datetime-format > > > > > > Required: No > > > > > > This option defines a multiline start pattern in Python `strftime` format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. > > > > > > One example of a use case for using this format is for parsing output such as a stack dump, which might otherwise be logged in multiple entries. The correct pattern allows it to be captured in a single entry. > > > > > > For more information, see [awslogs-datetime-format](https://docs.docker.com/config/containers/logging/awslogs/#awslogs-datetime-format) . > > > > > > You cannot configure both the `awslogs-datetime-format` and `awslogs-multiline-pattern` options. > > > > > > #### NOTE > > > > > > Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. > > > > > > awslogs-multiline-pattern > > > > > > Required: No > > > > > > This option defines a multiline start pattern that uses a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. > > > > > > For more information, see [awslogs-multiline-pattern](https://docs.docker.com/config/containers/logging/awslogs/#awslogs-multiline-pattern) . > > > > > > This option is ignored if `awslogs-datetime-format` is also configured. > > > > > > You cannot configure both the `awslogs-datetime-format` and `awslogs-multiline-pattern` options. > > > > > > #### NOTE > > > > > > Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. > > > > > > The following options apply to all supported log drivers. > > > > > > > mode > > > > > > Required: No > > > > > > Valid values: `non-blocking` | `blocking` > > > > > > This option defines the delivery mode of log messages from the container to the log driver specified using `logDriver` . The delivery mode you choose affects application availability when the flow of logs from container is interrupted. > > > > > > If you use the `blocking` mode and the flow of logs is interrupted, calls from container code to write to the `stdout` and `stderr` streams will block. The logging thread of the application will block as a result. This may cause the application to become unresponsive and lead to container healthcheck failure. > > > > > > If you use the `non-blocking` mode, the container’s logs are instead stored in an in-memory intermediate buffer configured with the `max-buffer-size` option. This prevents the application from becoming unresponsive when logs cannot be sent. We recommend using this mode if you want to ensure service availability and are okay with some log loss. For more information, see Preventing log loss with non-blocking mode in the \`\`awslogs\` container log driver <[http://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/](http://aws.amazon.com/blogs/containers/preventing-log-loss-with-non-blocking-mode-in-the-awslogs-container-log-driver/)>\`_\_ . > > > > > > You can set a default `mode` for all containers in a specific Amazon Web Services Region by using the `defaultLogDriverMode` account setting. If you don’t specify the `mode` option or configure the account setting, Amazon ECS will default to the `non-blocking` mode. For more information about the account setting, see [Default log driver mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#default-log-driver-mode) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > #### NOTE > > > > > > On June 25, 2025, Amazon ECS changed the default log driver mode from `blocking` to `non-blocking` to prioritize task availability over logging. To continue using the `blocking` mode after this change, do one of the following: > > > > > > * Set the `mode` option in your container definition’s `logConfiguration` as `blocking` . > > > > > > * Set the `defaultLogDriverMode` account setting to `blocking` . > > > > > > max-buffer-size > > > > > > Required: No > > > > > > Default value: `10m` > > > > > > When `non-blocking` mode is used, the `max-buffer-size` log option controls the size of the buffer that’s used for intermediate message storage. Make sure to specify an adequate buffer size based on your application. When the buffer fills up, further logs cannot be stored. Logs that cannot be stored are lost. > > > > > > To route logs using the `splunk` log router, you need to specify a `splunk-token` and a `splunk-url` . > > > > > > When you use the `awsfirelens` log router to route logs to an Amazon Web Services Service or Amazon Web Services Partner Network destination for log storage and analytics, you can set the `log-driver-buffer-limit` option to limit the number of events that are buffered in memory, before being sent to the log router container. It can help to resolve potential log loss issue because high throughput might result in memory running out for the buffer inside of Docker. > > > > > > Other options you can specify when using `awsfirelens` to route logs depend on the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region with `region` and a name for the log stream with `delivery_stream` . > > > > > > When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with `region` and a data stream name with `stream` . > > > > > > When you export logs to Amazon OpenSearch Service, you can specify options like `Name` , `Host` (OpenSearch Service endpoint without protocol), `Port` , `Index` , `Type` , `Aws_auth` , `Aws_region` , `Suppress_Type_Name` , and `tls` . For more information, see [Under the hood: FireLens for Amazon ECS Tasks](http://aws.amazon.com/blogs/containers/under-the-hood-firelens-for-amazon-ecs-tasks/) . > > > > > > When you export logs to Amazon S3, you can specify the bucket using the `bucket` option. You can also specify `region` , `total_file_size` , `upload_timeout` , and `use_put_object` as options. > > > > > > This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` > > > > > > key -> (string) > > > > > > value -> (string) > > > > > secretOptions -> (list) > > > > > > The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > (structure) > > > > > > > An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways: > > > > > > > * To inject sensitive data into your containers as environment variables, use the `secrets` container definition parameter. > > > > > > > * To reference sensitive information in the log configuration of a container, use the `secretOptions` container definition parameter. > > > > > > > For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > > name -> (string) [required] > > > > > > > > The name of the secret. > > > > > > > valueFrom -> (string) [required] > > > > > > > > The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store. > > > > > > > > For information about the require Identity and Access Management permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > > > #### NOTE > > > > > > > > If the SSM Parameter Store parameter exists in the same Region as the task you’re launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. > > > > accessLogConfiguration -> (structure) > > > > > The configuration for Service Connect access logging. Access logs capture detailed information about requests made to your service, including request patterns, response codes, and timing data. They can be useful for debugging connectivity issues, monitoring service performance, and auditing service-to-service communication for security and compliance purposes. > > > > > #### NOTE > > > > > To enable access logs, you must also specify a `logConfiguration` in the `serviceConnectConfiguration` . > > > > > format -> (string) [required] > > > > > > The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools. > > > > > > Possible values: > > > > > > * `TEXT` > > > > > > * `JSON` > > > > > includeQueryParameters -> (string) > > > > > > Specifies whether to include query parameters in Service Connect access logs. > > > > > > When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is `DISABLED` . > > > > > > Possible values: > > > > > > * `DISABLED` > > > > > > * `ENABLED` > > > > containerConfigurations -> (list) > > > > > The settings for the Service Connect proxy container that Amazon ECS adds to each task in this service. Each object in the list sets exactly one setting, and each setting can appear only once in the list. > > > > > Your changes to these settings apply only to tasks that Amazon ECS launches after you update the service. Your running tasks keep their existing settings until Amazon ECS replaces them. If you update the `serviceConnectConfiguration` of your service and don’t include `containerConfigurations` , the proxy container settings return to their defaults. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `10` > > > > > (tagged union structure) > > > > > > Contains a configuration setting for the Service Connect proxy container, such as the log level. Specify exactly one member in each object. > > > > > > #### NOTE > > > > > > This is a Tagged Union structure. Only one of the following top level keys can be set: `logLevel`. > > > > > > logLevel -> (string) > > > > > > > The log level of the Service Connect proxy container. Set the log level to `debug` to collect more detailed proxy logs when you troubleshoot connectivity issues between services, and set it back to `info` when you finish. Debug logging increases the volume of logs that the proxy container writes. If you don’t specify a log level, the default is `info` . > > > > > > > Possible values: > > > > > > > * `debug` > > > > > > > * `info` > > > serviceConnectResources -> (list) > > > > The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name. > > > > (structure) > > > > > The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name of this Amazon ECS service. > > > > > A task can resolve the `dnsName` for each of the `clientAliases` of a service. However a task can’t resolve the discovery names. If you want to connect to a service, refer to the `ServiceConnectConfiguration` of that service for the list of `clientAliases` that you can use. > > > > > discoveryName -> (string) > > > > > > The discovery name of this Service Connect resource. > > > > > > The `discoveryName` is the name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can’t start with a hyphen. > > > > > > If the `discoveryName` isn’t specified, the port mapping name from the task definition is used in `portName.namespace` . > > > > > discoveryArn -> (string) > > > > > > The Amazon Resource Name (ARN) for the service in Cloud Map that matches the discovery name for this Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, Service Connect can’t ensure connectivity outside of Amazon ECS. > > > volumeConfigurations -> (list) > > > > The details of the volume that was `configuredAtLaunch` . You can configure different settings like the size, throughput, volumeType, and ecryption in [ServiceManagedEBSVolumeConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html) . The `name` of the volume must match the `name` from the task definition. > > > > (structure) > > > > > The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. > > > > > name -> (string) [required] > > > > > > The name of the volume. This value must match the volume name from the `Volume` object in the task definition. > > > > > managedEBSVolume -> (structure) > > > > > > The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. > > > > > > encrypted -> (boolean) > > > > > > > Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as `false` , the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the `Encrypted` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > > > kmsKeyId -> (string) > > > > > > > The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the `KmsKeyId` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . For more information about encrypting Amazon EBS volumes attached to tasks, see [Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html) . > > > > > > > #### WARNING > > > > > > > Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails. > > > > > > volumeType -> (string) > > > > > > > The volume type. This parameter maps 1:1 with the `VolumeType` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide* . > > > > > > > The following are the supported volume types. > > > > > > > * General Purpose SSD: `gp2` |`gp3` > > > > > > > * Provisioned IOPS SSD: `io1` |`io2` > > > > > > > * Throughput Optimized HDD: `st1` > > > > > > > * Cold HDD: `sc1` > > > > > > > * Magnetic: `standard` > > > > > > > #### NOTE > > > > > > > The magnetic volume type is not supported on Fargate. > > > > > > sizeInGiB -> (integer) > > > > > > > The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the `Size` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > > > > The following are the supported volume size values for each volume type. > > > > > > > * `gp2` and `gp3` : 1-16,384 > > > > > > > * `io1` and `io2` : 4-16,384 > > > > > > > * `st1` and `sc1` : 125-16,384 > > > > > > > * `standard` : 1-1,024 > > > > > > snapshotId -> (string) > > > > > > > The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service. You must specify either `snapshotId` or `sizeInGiB` in your volume configuration. This parameter maps 1:1 with the `SnapshotId` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > > > volumeInitializationRate -> (integer) > > > > > > > The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a `snapshotId` . For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EBS User Guide* . > > > > > > iops -> (integer) > > > > > > > The number of I/O operations per second (IOPS). For `gp3` , `io1` , and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. > > > > > > > The following are the supported values for each volume type. > > > > > > > * `gp3` : 3,000 - 16,000 IOPS > > > > > > > * `io1` : 100 - 64,000 IOPS > > > > > > > * `io2` : 100 - 256,000 IOPS > > > > > > > This parameter is required for `io1` and `io2` volume types. The default for `gp3` volumes is `3,000 IOPS` . This parameter is not supported for `st1` , `sc1` , or `standard` volume types. > > > > > > > This parameter maps 1:1 with the `Iops` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > > > throughput -> (integer) > > > > > > > The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the `Throughput` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > > > > #### WARNING > > > > > > > This parameter is only supported for the `gp3` volume type. > > > > > > tagSpecifications -> (list) > > > > > > > The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the `TagSpecifications.N` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference* . > > > > > > > (structure) > > > > > > > > The tag specifications of an Amazon EBS volume. > > > > > > > > resourceType -> (string) [required] > > > > > > > > > The type of volume resource. > > > > > > > > > Possible values: > > > > > > > > > * `volume` > > > > > > > > tags -> (list) > > > > > > > > > The tags applied to this Amazon EBS volume. `AmazonECSCreated` and `AmazonECSManaged` are reserved tags that can’t be used. > > > > > > > > > Constraints: > > > > > > > > > * min: `0` > > > > > > > > > * max: `50` > > > > > > > > > (structure) > > > > > > > > > > The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them. > > > > > > > > > > The following basic restrictions apply to tags: > > > > > > > > > > * Maximum number of tags per resource - 50 > > > > > > > > > > * For each resource, each tag key must be unique, and each tag key can have only one value. > > > > > > > > > > * Maximum key length - 128 Unicode characters in UTF-8 > > > > > > > > > > * Maximum value length - 256 Unicode characters in UTF-8 > > > > > > > > > > * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . \_ : / @. > > > > > > > > > > * Tag keys and values are case-sensitive. > > > > > > > > > > * Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. > > > > > > > > > > key -> (string) > > > > > > > > > > > One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values. > > > > > > > > > > > Constraints: > > > > > > > > > > > * min: `1` > > > > > > > > > > > * max: `128` > > > > > > > > > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` > > > > > > > > > > value -> (string) > > > > > > > > > > > The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key). > > > > > > > > > > > Constraints: > > > > > > > > > > > * min: `0` > > > > > > > > > > > * max: `256` > > > > > > > > > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` > > > > > > > > propagateTags -> (string) > > > > > > > > > Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a `SERVICE` specified in `ServiceVolumeConfiguration` . If no value is specified, the tags aren’t propagated. > > > > > > > > > Possible values: > > > > > > > > > * `TASK_DEFINITION` > > > > > > > > > * `SERVICE` > > > > > > > > > * `NONE` > > > > > > roleArn -> (string) [required] > > > > > > > The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed `AmazonECSInfrastructureRolePolicyForVolumes` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide* . > > > > > > filesystemType -> (string) > > > > > > > The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the tasks will fail to start. > > > > > > > The available Linux filesystem types are `ext3` , `ext4` , and `xfs` . If no value is specified, the `xfs` filesystem type is used by default. > > > > > > > The available Windows filesystem types are `NTFS` . > > > > > > > Possible values: > > > > > > > * `ext3` > > > > > > > * `ext4` > > > > > > > * `xfs` > > > > > > > * `ntfs` > > > fargateEphemeralStorage -> (structure) > > > > The Fargate ephemeral storage settings for the deployment. > > > > kmsKeyId -> (string) > > > > > Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment. > > > vpcLatticeConfigurations -> (list) > > > > The VPC Lattice configuration for the service deployment. > > > > (structure) > > > > > The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to. > > > > > roleArn -> (string) [required] > > > > > > The ARN of the IAM role to associate with this VPC Lattice configuration. This is the Amazon ECS infrastructure IAM role that is used to manage your VPC Lattice infrastructure. > > > > > targetGroupArn -> (string) [required] > > > > > > The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to. > > > > > portName -> (string) [required] > > > > > > The name of the port mapping to register in the VPC Lattice target group. This is the name of the `portMapping` you defined in your task definition. > > > > > advancedConfiguration -> (structure) > > > > > > The advanced settings for VPC Lattice used in blue/green deployments. Specify the alternate target group and listener rules required for traffic shifting during blue/green deployments. For more information, see [Required resources for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-deployment-implementation.html) in the *Amazon Elastic Container Service Developer Guide* . > > > > > > alternateTargetGroupArn -> (string) > > > > > > > The Amazon Resource Name (ARN) of the alternate target group associated with the VPC Lattice Configuration for Amazon ECS blue/green deployments. > > > > > > productionListenerRule -> (string) > > > > > > > The Amazon Resource Name (ARN) that identifies the production listener rule or listener for routing production traffic. > > > > > > testListenerRule -> (string) > > > > > > > The Amazon Resource Name (ARN) that identifies the test listener rule or listener for routing test traffic. > roleArn -> (string) > > The ARN of the IAM role that’s associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer. > events -> (list) > > The event stream for your service. A maximum of 100 of the latest events are displayed. > > (structure) > > > The details for an event that’s associated with a service. > > > id -> (string) > > > > The ID string for the event. > > > createdAt -> (timestamp) > > > > The Unix timestamp for the time when the event was triggered. > > > message -> (string) > > > > The event message. > createdAt -> (timestamp) > > The Unix timestamp for the time when the service was created. > currentServiceDeployment -> (string) > > The ARN of the current service deployment. > currentServiceRevisions -> (list) > > The list of the service revisions. > > (structure) > > > The summary of the current service revision configuration > > > arn -> (string) > > > > The ARN of the current service revision. > > > requestedTaskCount -> (integer) > > > > The number of requested tasks in the current service revision > > > runningTaskCount -> (integer) > > > > The number of running tasks of the current service revision > > > pendingTaskCount -> (integer) > > > > The number of pending tasks in the current service revision > placementConstraints -> (list) > > The placement constraints for the tasks in the service. > > (structure) > > > An object representing a constraint on task placement. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide* . > > > #### NOTE > > > If you’re using the Fargate launch type, task placement constraints aren’t supported. > > > type -> (string) > > > > The type of constraint. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance. Use `memberOf` to restrict the selection to a group of valid candidates. > > > > Possible values: > > > > * `distinctInstance` > > > > * `memberOf` > > > expression -> (string) > > > > A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can’t specify an expression if the constraint type is `distinctInstance` . For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide* . > placementStrategy -> (list) > > The placement strategy that determines how tasks for the service are placed. > > (structure) > > > The task placement strategy for a task or service. For more information, see [Task placement strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide* . > > > type -> (string) > > > > The type of placement strategy. The `random` placement strategy randomly places tasks on available candidates. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that’s specified with the `field` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task. > > > > Possible values: > > > > * `random` > > > > * `spread` > > > > * `binpack` > > > field -> (string) > > > > The field to apply the placement strategy against. For the `spread` placement strategy, valid values are `instanceId` (or `host` , which has the same effect), or any platform or custom attribute that’s applied to a container instance, such as `attribute:ecs.availability-zone` . For the `binpack` placement strategy, valid values are `cpu` and `memory` . For the `random` placement strategy, this field is not used. > networkConfiguration -> (structure) > > The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the `awsvpc` networking mode. > > awsvpcConfiguration -> (structure) > > > The VPC subnets and security groups that are associated with a task. > > > #### NOTE > > > All specified subnets and security groups must be from the same VPC. > > > subnets -> (list) [required] > > > > The IDs of the subnets associated with the task or service. There’s a limit of 16 subnets that can be specified. > > > > #### NOTE > > > > All specified subnets must be from the same VPC. > > > > (string) > > > securityGroups -> (list) > > > > The IDs of the security groups associated with the task or service. If you don’t specify a security group, the default security group for the VPC is used. There’s a limit of 5 security groups that can be specified. > > > > #### NOTE > > > > All specified security groups must be from the same VPC. > > > > (string) > > > assignPublicIp -> (string) > > > > Whether the task’s elastic network interface receives a public IP address. > > > > Consider the following when you set this value: > > > > * When you use `create-service` or `update-service` , the default is `DISABLED` . > > > > * When the service `deploymentController` is `ECS` , the value must be `DISABLED` . > > > > Possible values: > > > > * `ENABLED` > > > > * `DISABLED` > healthCheckGracePeriodSeconds -> (integer) > > 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 your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count. > schedulingStrategy -> (string) > > The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) . > > There are two service scheduler strategies available. > > * `REPLICA` -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. > > * `DAEMON` -The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don’t meet the placement constraints. > > #### NOTE > > Fargate tasks don’t support the `DAEMON` scheduling strategy. > > Possible values: > > * `REPLICA` > > * `DAEMON` > deploymentController -> (structure) > > The deployment controller type the service is using. > > type -> (string) [required] > > > The deployment controller type to use. > > > The deployment controller is the mechanism that determines how tasks are deployed for your service. The valid options are: > > > * ECS When you create a service which uses the `ECS` deployment controller, you can choose between the following deployment strategies: > > > * `ROLLING` : When you create a service which uses the *rolling update* (`ROLLING` ) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. Rolling update deployments are best suited for the following scenarios: > > > * Gradual service updates: You need to update your service incrementally without taking the entire service offline at once. > > > * Limited resource requirements: You want to avoid the additional resource costs of running two complete environments simultaneously (as required by blue/green deployments). > > > * Acceptable deployment time: Your application can tolerate a longer deployment process, as rolling updates replace tasks one by one. > > > * No need for instant roll back: Your service can tolerate a rollback process that takes minutes rather than seconds. > > > * Simple deployment process: You prefer a straightforward deployment approach without the complexity of managing multiple environments, target groups, and listeners. > > > * No load balancer requirement: Your service doesn’t use or require a load balancer, Application Load Balancer, Network Load Balancer, or Service Connect (which are required for blue/green deployments). > > > * Stateful applications: Your application maintains state that makes it difficult to run two parallel environments. > > > * Cost sensitivity: You want to minimize deployment costs by not running duplicate environments during deployment. > > > Rolling updates are the default deployment strategy for services and provide a balance between deployment safety and resource efficiency for many common application scenarios. > > > * `BLUE_GREEN` : A *blue/green* deployment strategy (`BLUE_GREEN` ) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed. Amazon ECS blue/green deployments are best suited for the following scenarios: > > > * Service validation: When you need to validate new service revisions before directing production traffic to them > > > * Zero downtime: When your service requires zero-downtime deployments > > > * Instant roll back: When you need the ability to quickly roll back if issues are detected > > > * Load balancer requirement: When your service uses Application Load Balancer, Network Load Balancer, or Service Connect > > > * External Use a third-party deployment controller. > > > * Blue/green deployment (powered by CodeDeploy) CodeDeploy installs an updated version of the application as a new replacement task set and reroutes production traffic from the original application task set to the replacement task set. The original task set is terminated after a successful deployment. Use this deployment controller to verify a new deployment of a service before sending production traffic to it. > > > Possible values: > > > * `ECS` > > > * `CODE_DEPLOY` > > > * `EXTERNAL` > tags -> (list) > > The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value. > > The following basic restrictions apply to tags: > > * Maximum number of tags per resource - 50 > > * For each resource, each tag key must be unique, and each tag key can have only one value. > > * Maximum key length - 128 Unicode characters in UTF-8 > > * Maximum value length - 256 Unicode characters in UTF-8 > > * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . \_ : / @. > > * Tag keys and values are case-sensitive. > > * Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. > > Constraints: > > * min: `0` > > * max: `50` > > (structure) > > > The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them. > > > The following basic restrictions apply to tags: > > > * Maximum number of tags per resource - 50 > > > * For each resource, each tag key must be unique, and each tag key can have only one value. > > > * Maximum key length - 128 Unicode characters in UTF-8 > > > * Maximum value length - 256 Unicode characters in UTF-8 > > > * If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . \_ : / @. > > > * Tag keys and values are case-sensitive. > > > * Do not use `aws:` , `AWS:` , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. > > > key -> (string) > > > > One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values. > > > > Constraints: > > > > * min: `1` > > > > * max: `128` > > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` > > > value -> (string) > > > > The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key). > > > > Constraints: > > > > * min: `0` > > > > * max: `256` > > > > * pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)` > createdBy -> (string) > > The principal that created the service. > enableECSManagedTags -> (boolean) > > Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide* . > propagateTags -> (string) > > 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. > > Possible values: > > * `TASK_DEFINITION` > > * `SERVICE` > > * `NONE` > enableExecuteCommand -> (boolean) > > Determines whether the execute command functionality is turned on for the service. If `true` , the execute command functionality is turned on for all containers in tasks as part of the service. > availabilityZoneRebalancing -> (string) > > Indicates whether to use Availability Zone rebalancing for the service. > > For more information, see [Balancing an Amazon ECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the \* *Amazon Elastic Container Service Developer Guide* \* . > > The default behavior of `AvailabilityZoneRebalancing` differs between create and update requests: > > * For create service requests, when no value is specified for `AvailabilityZoneRebalancing` , Amazon ECS defaults the value to `ENABLED` . > > * For update service requests, when no value is specified for `AvailabilityZoneRebalancing` , Amazon ECS defaults to the existing service’s `AvailabilityZoneRebalancing` value. If the service never had an `AvailabilityZoneRebalancing` value set, Amazon ECS treats this as `DISABLED` . > > Possible values: > > * `ENABLED` > > * `DISABLED` > resourceManagementType -> (string) > > Identifies whether an ECS Service is an Express Service managed by ECS, or managed by the customer. The valid values are `ECS` and `CUSTOMER` > > Possible values: > > * `CUSTOMER` > > * `ECS`