Skip to main content

Amazon ECS Service

Deploy an Amazon ECS Service

View on GitHub

Reference​

  • alarm_sns_topic_arns_us_east_1 — A list of SNS topic ARNs to notify when the route53 health check changes to ALARM, OK, or INSUFFICIENT_DATA state. Note: these SNS topics MUST be in us-east-1! This is because Route 53 only sends CloudWatch metrics to us-east-1, so we must create the alarm in that region, and therefore, can only notify SNS topics in that region
  • alb_sticky_session_cookie_duration — The time period, in seconds, during which requests from a client should be routed to the same Target. After this time period expires, the load balancer-generated cookie is considered stale. The acceptable range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). Only used if elb_target_groups is set.
  • canary_container_definitions — List of container definitions to use for the canary ECS task. Each entry corresponds to a different ECS container definition.
  • canary_version — Which version of the ECS Service Docker container to deploy as a canary (e.g. 0.57)
  • capacity_provider_strategy — The capacity provider strategy to use for the service. Note that the capacity providers have to be present on the ECS cluster before deploying the ECS service. When provided, launch_type is ignored.
  • clb_container_name — The name of the container, as it appears in the task_arn Task definition, to associate with a CLB. Currently, ECS can only associate a CLB with a single container per service. Only used if clb_name is set.
  • clb_name — The name of a Classic Load Balancer (CLB) to associate with this service. Containers in the service will automatically register with the CLB when booting up. Set to null if using ELBv2.
  • container_definitions — List of container definitions to use for the ECS task. Each entry corresponds to a different ECS container definition.
  • cpu — The number of CPU units to allocate to the ECS Service.
  • create_route53_entry — Set to true if you want a DNS record automatically created and pointed at the the load balancer for the ECS service
  • custom_ecs_service_role_name — The name to use for the ECS Service IAM role, which is used to grant permissions to the ECS service to register the task IPs to ELBs.
  • default_listener_arns — A map of all the listeners on the load balancer. The keys should be the port numbers and the values should be the ARN of the listener for that port.
  • default_listener_ports — The default port numbers on the load balancer to attach listener rules to. You can override this default on a rule-by-rule basis by setting the listener_ports parameter in each rule. The port numbers specified in this variable and the listener_ports parameter must exist in listener_arns.
  • dependencies — Create a dependency between the resources in this module to the interpolated values in this list (and thus the source resources). In other words, the resources in this module will now depend on the resources backing the values in this list such that those resources need to be created before the resources in this module, and the resources in this module need to be destroyed before the resources in the list.
  • deployment_check_loglevel — Set the logging level of the deployment check script. You can set this to error, warn, or info, in increasing verbosity.
  • deployment_maximum_percent — The upper limit, as a percentage of desired_number_of_tasks, of the number of running tasks that can be running in a service during a deployment. Setting this to more than 100 means that during deployment, ECS will deploy new instances of a Task before undeploying the old ones.
  • deployment_minimum_healthy_percent — The lower limit, as a percentage of desired_number_of_tasks, of the number of running tasks that must remain running and healthy in a service during a deployment. Setting this to less than 100 means that during deployment, ECS may undeploy old instances of a Task before deploying new ones.
  • desired_number_of_canary_tasks — How many instances of the ECS Service to run across the ECS cluster for a canary deployment. Typically, only 0 or 1 should be used.
  • domain_name — The domain name to create a route 53 record for. This DNS record will point to the load balancer for the ECS service
  • ecs_cluster_arn — The ARN of the cluster to which the ecs service should be deployed.
  • ecs_cluster_name — The name of the ecs cluster to deploy the ecs service onto.
  • ecs_node_port_mappings — A map of ports to be opened via security groups applied to the EC2 instances that back the ECS cluster, when not using fargate. The key should be the container port and the value should be what host port to map it to.
  • elb_slow_start — The amount time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is 0 seconds. Only used if elb_target_groups is set.
  • elb_target_groups — Configurations for ELB target groups for ALBs and NLBs that should be associated with the ECS Tasks. Each entry corresponds to a separate target group. Set to the empty object ({}) if you are not using an ALB or NLB.
  • enable_ecs_deployment_check — Whether or not to enable the ECS deployment check binary to make terraform wait for the task to be deployed. See ecs_deploy_check_binaries for more details. You must install the companion binary before the check can be used. Refer to the README for more details.
  • enable_route53_health_check — Set this to true to create a route 53 health check and Cloudwatch alarm that will alert if your domain becomes unreachable
  • health_check_enabled — If true, enable health checks on the target group. Only applies to ELBv2. For CLBs, health checks are not configurable.
  • health_check_grace_period_seconds — Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 2,147,483,647. Only valid for services configured to use load balancers.
  • health_check_healthy_threshold — The number of consecutive successful health checks required before considering an unhealthy Target healthy. The acceptable range is 2 to 10.
  • health_check_interval — The approximate amount of time, in seconds, between health checks of an individual Target. Minimum value 5 seconds, Maximum value 300 seconds.
  • health_check_matcher — The HTTP codes to use when checking for a successful response from a Target. You can specify multiple values (e.g. '200,202') or a range of values (e.g. '200-299'). Required when using ALBs.
  • health_check_path — The ping path that is the destination on the Targets for health checks. Required when using ALBs.
  • health_check_port — The port the ELB uses when performing health checks on Targets. The default is to use the port on which each target receives traffic from the load balancer, indicated by the value 'traffic-port'.
  • health_check_timeout — The amount of time, in seconds, during which no response from a Target means a failed health check. The acceptable range is 2 to 60 seconds.
  • hosted_zone_id — The ID of the Route 53 hosted zone into which the Route 53 DNS record should be written
  • iam_policy — An object defining the policy to attach to the ECS task. Accepts a map of objects, where the map keys are sids for IAM policy statements, and the object fields are the resources, actions, and the effect ("Allow" or "Deny") of the statement.
  • lb_hosted_zone_id — The ID of the Route 53 Hosted Zone in which to create a DNS A record pointed to the ECS service's load balancer
  • max_number_of_tasks — The maximum number of instances of the ECS Service to run. Auto scaling will never scale out above this number.
  • memory — How much memory, in MB, to give the ECS Service.
  • min_number_of_tasks — The minimum number of instances of the ECS Service to run. Auto scaling will never scale in below this number.
  • placement_constraint_expression — Cluster Query Language expression to apply to the constraint for matching. Does not need to be specified for the distinctInstance constraint type.
  • placement_constraint_type — The type of constraint to apply for container instance placement. The only valid values at this time are memberOf and distinctInstance.
  • placement_strategy_field — The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
  • placement_strategy_type — The strategy to use when placing ECS tasks on EC2 instances. Can be binpack (default), random, or spread.
  • propagate_tags — Whether tags should be propogated to the tasks from the service or from the task definition. Valid values are SERVICE and TASK_DEFINITION. Defaults to SERVICE. If set to null, no tags are created for tasks.
  • route53_health_check_path — The path, without any leading slash, that can be used as a health check (e.g. healthcheck) by Route 53. Should return a 200 OK when the service is up and running.
  • secrets_access — A list of ARNs of Secrets Manager secrets that the task should have permissions to read. The IAM role for the task will be granted secretsmanager:GetSecretValue for each secret in the list. The ARN can be either the complete ARN, including the randomly generated suffix, or the ARN without the suffix. If the latter, the module will look up the full ARN automatically. This is helpful in cases where you don't yet know the randomly generated suffix because the rest of the ARN is a predictable value.
  • secrets_manager_arns — A list of ARNs for Secrets Manager secrets that the ECS execution IAM policy should be granted access to read. Note that this is different from the ECS task IAM policy. The execution policy is concerned with permissions required to run the ECS task.
  • service_name — The name of the ECS service (e.g. my-service-stage)
  • service_tags — A map of tags to apply to the ECS service. Each item in this list should be a map with the parameters key and value.
  • task_definition_tags — A map of tags to apply to the task definition. Each item in this list should be a map with the parameters key and value.