terraform/website/source/docs/providers/aws/r/ecs_service.html.markdown

layout	page_title	sidebar_current	description
aws	AWS: aws_ecs_service	docs-aws-resource-ecs-service	Provides an ECS service.

aws_ecs_service

-> Note: To prevent a race condition during service deletion, make sure to set depends_on to the related aws_iam_role_policy; otherwise, the policy may be destroyed too soon and the ECS service will then get stuck in the DRAINING state.

Provides an ECS service - effectively a task that is expected to run until an error occurs or a user terminates it (typically a webserver or a database).

See ECS Services section in AWS developer guide.

Example Usage

resource "aws_ecs_service" "mongo" {
  name            = "mongodb"
  cluster         = "${aws_ecs_cluster.foo.id}"
  task_definition = "${aws_ecs_task_definition.mongo.arn}"
  desired_count   = 3
  iam_role        = "${aws_iam_role.foo.arn}"
  depends_on      = ["aws_iam_role_policy.foo"]

  placement_strategy {
    type  = "binpack"
    field = "cpu"
  }

  load_balancer {
    elb_name       = "${aws_elb.foo.name}"
    container_name = "mongo"
    container_port = 8080
  }

  placement_constraints {
    type       = "memberOf"
    expression = "attribute:ecs.availability-zone in [us-west-2a, us-west-2b]"
  }
}

Argument Reference

The following arguments are supported:

• name - (Required) The name of the service (up to 255 letters, numbers, hyphens, and underscores)
• task_definition - (Required) The family and revision (family:revision) or full ARN of the task definition that you want to run in your service.
• desired_count - (Required) The number of instances of the task definition to place and keep running
• cluster - (Optional) ARN of an ECS cluster
• iam_role - (Optional) The ARN of IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.
• deployment_maximum_percent - (Optional) The 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.
• deployment_minimum_healthy_percent - (Optional) The 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.
• placement_strategy - (Optional) Service level strategy rules that are taken into consideration during task placement. The maximum number of placement_strategy blocks is 5. Defined below.
• load_balancer - (Optional) A load balancer block. Load balancers documented below.
• placement_constraints - (Optional) rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. Defined below.

-> Note: As a result of an AWS limitation, a single load_balancer can be attached to the ECS service at most. See related docs.

Load balancers support the following:

• elb_name - (Required for ELB Classic) The name of the ELB (Classic) to associate with the service.
• target_group_arn - (Required for ALB) The ARN of the ALB target group to associate with the service.
• container_name - (Required) The name of the container to associate with the load balancer (as it appears in a container definition).
• container_port - (Required) The port on the container to associate with the load balancer.

placement_strategy

placement_strategy supports the following:

• type - (Required) The type of placement strategy. Must be one of: binpack, random, or spread
• field - (Optional) 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. For the binpack type, valid values are memory and cpu. For the random type, this attribute is not needed. For more information, see Placement Strategy.

placement_constraints

placement_constraints support the following:

• type - (Required) The type of constraint. The only valid values at this time are memberOf and distinctInstance.
• expression - (Optional) Cluster Query Language expression to apply to the constraint. Does not need to be specified for the distinctInstance type. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

Attributes Reference

The following attributes are exported:

• id - The Amazon Resource Name (ARN) that identifies the service
• name - The name of the service
• cluster - The Amazon Resource Name (ARN) of cluster which the service runs on
• iam_role - The ARN of IAM role used for ELB
• desired_count - The number of instances of the task definition