Optional
clusterOptional
deploymentConfiguration block for deployment circuit breaker.
Optional
deploymentConfiguration block containing deployment controller configuration.
Optional
deploymentThe upper limit (as a percentage of the service's desiredCount) of the number of running
tasks that can be running in a service during a deployment. Not valid when using the DAEMON
scheduling strategy.
Optional
deploymentThe lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain running and healthy in a service during a deployment.
Optional
desiredThe number of instances of the task definition to place and keep running. Defaults to 1. Do
not specify if using the DAEMON
scheduling strategy.
Optional
enableSpecifies whether to enable Amazon ECS managed tags for the tasks within the service.
Optional
enableSpecifies whether to enable Amazon ECS Exec for the tasks within the service.
Optional
forceEnable to force a new task deployment of the service. This can be used to update tasks to use a newer Docker image with same image/tag combination (e.g. myimage:latest) or immediately deploy orderedPlacementStrategies and placementConstraints updates.
Optional
healthSeconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 7200. Only valid for services configured to use load balancers.
Optional
iamARN of the IAM role that allows Amazon ECS to make calls to your load balancer on your
behalf. This parameter is required if you are using a load balancer with your service, but
only if your task definition does not use the awsvpc
network mode. If using awsvpc
network mode, do not specify this role. If your account has already created the Amazon ECS
service-linked role, that role is used by default for your service unless you specify a role
here.
Optional
loadA load balancer block. Load balancers documented below.
Optional
nameThe name of the service (up to 255 letters, numbers, hyphens, and underscores)
Optional
orderedService level strategy rules that are taken into consideration during task placement. List
from top to bottom in order of precedence. The maximum number of ordered_placement_strategy
blocks is 5
. Defined below.
Optional
osOptional
placementrules that are taken into consideration during task placement. Maximum number of
placement_constraints
is 10
. Defined below.
Optional
propagateSpecifies whether to propagate the tags from the task definition or the service
to the tasks. The valid values are SERVICE
and TASK_DEFINITION
.
Optional
schedulingThe scheduling strategy to use for the service. The valid values are REPLICA
and DAEMON
.
Defaults to REPLICA
. Note that Fargate tasks do not support the DAEMON
scheduling
strategy.
Optional
securityThe security groups to use for the instances.
Defaults to [cluster.securityGroups] if unspecified.
Optional
serviceThe service discovery registries for the service. The maximum number of service_registries
blocks is 1
.
Optional
subnetsThe subnets to connect the instances to. If unspecified then these will be the public subnets of the cluster's vpc.
Optional
tagsKey-value mapping of resource tags
Optional
taskThe task definition to create the service from. Either [taskDefinition] or [taskDefinitionArgs] must be provided.
Optional
taskThe task definition to create the service from. Either [taskDefinition] or [taskDefinitionArgs] must be provided.
Optional
waitWait for the service to reach a steady state (like aws ecs wait services-stable
)
before continuing. Defaults to true
.
Generated using TypeDoc
Cluster this service will run in.