# NetworkMultipleTargetGroupsEc2Service

An EC2 service running on an ECS cluster fronted by a network load balancer.

Extends: Construct › NetworkMultipleTargetGroupsServiceBase › NetworkMultipleTargetGroupsEc2Service
Implements: IConstruct, IDependable

- Source: [`aws-ecs-patterns/lib/ecs/network-multiple-target-groups-ecs-service.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-ecs-patterns/lib/ecs/network-multiple-target-groups-ecs-service.ts#L84)
- Type last changed: v2.37.0 · 9 Aug 2022

## Example

```ts
// Two network load balancers, each with their own listener and target group.
declare const cluster: ecs.Cluster;
const loadBalancedEc2Service = new ecsPatterns.NetworkMultipleTargetGroupsEc2Service(this, 'Service', {
  cluster,
  memoryLimitMiB: 256,
  taskImageOptions: {
    image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  },
  loadBalancers: [
    {
      name: 'lb1',
      listeners: [
        {
          name: 'listener1',
        },
      ],
    },
    {
      name: 'lb2',
      listeners: [
        {
          name: 'listener2',
        },
      ],
    },
  ],
  targetGroups: [
    {
      containerPort: 80,
      listener: 'listener1',
    },
    {
      containerPort: 90,
      listener: 'listener2',
    },
  ],
});
```

## Initializer

```ts
new NetworkMultipleTargetGroupsEc2Service(scope: Construct, id: string, props?: NetworkMultipleTargetGroupsEc2ServiceProps)
```

## Construct Props

- `cloudMapOptions`: [CloudMapOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.CloudMapOptions.html) = AWS Cloud Map service discovery is not enabled. — The options for configuring an Amazon ECS service to use service discovery.

  **Default:** AWS Cloud Map service discovery is not enabled.

- `cluster`: [ICluster](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ICluster.html) = create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you. — The name of the cluster that hosts the service.

  If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

  **Default:** create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

- `cpu`: number = No minimum CPU units reserved. — The minimum number of CPU units to reserve for the container.

  Valid values, which determines your range of valid values for the memory parameter:

- `desiredCount`: number = The default is 1 for all new services and uses the existing service's desired count when updating an existing service. — The desired number of instantiations of the task definition to keep running on the service.

  The minimum value is 1

  **Default:** The default is 1 for all new services and uses the existing service's desired count when updating an existing service.

- `enableECSManagedTags`: boolean = false — Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

  For more information, see
  [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)

- `enableExecuteCommand`: boolean = false — Whether ECS Exec should be enabled.

- `healthCheckGracePeriod`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = defaults to 60 seconds if at least one load balancer is in-use and it is not already set — The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

  **Default:** defaults to 60 seconds if at least one load balancer is in-use and it is not already set

- `loadBalancers`: [NetworkLoadBalancerProps](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancerProps.html)[] = a new load balancer with a listener will be created. — The network load balancer that will serve traffic to the service.

  **Default:** a new load balancer with a listener will be created.

- `memoryLimitMiB`: number = No memory limit. — The amount (in MiB) of memory to present to the container.

  If your container attempts to exceed the allocated memory, the container
  is terminated.

  At least one of memoryLimitMiB and memoryReservationMiB is required.

- `memoryReservationMiB`: number = No memory reserved. — The soft limit (in MiB) of memory to reserve for the container.

  When system memory is under heavy contention, Docker attempts to keep the
  container memory to this soft limit. However, your container can consume more
  memory when it needs to, up to either the hard limit specified with the memory
  parameter (if applicable), or all of the available memory on the container
  instance, whichever comes first.

  At least one of memoryLimitMiB and memoryReservationMiB is required.

  Note that this setting will be ignored if TaskImagesOptions is specified.

- `placementConstraints`: [PlacementConstraint](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PlacementConstraint.html)[] = No constraints. — The placement constraints to use for tasks in the service.

  For more information, see
  [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).

- `placementStrategies`: [PlacementStrategy](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PlacementStrategy.html)[] = No strategies. — The placement strategies to use for tasks in the service.

  For more information, see
  [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).

- `propagateTags`: [PropagatedTagSource](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PropagatedTagSource.html) = none — Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

  Tags can only be propagated to the tasks within the service during service creation.

- `serviceName`: string = CloudFormation-generated name. — Name of the service.

- `targetGroups`: [NetworkTargetProps](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.NetworkTargetProps.html)[] = default portMapping registered as target group and attached to the first defined listener — Properties to specify NLB target groups.

  **Default:** default portMapping registered as target group and attached to the first defined listener

- `taskDefinition`: [Ec2TaskDefinition](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.Ec2TaskDefinition.html) = none — The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.

  [disable-awslint:ref-via-interface]

- `taskImageOptions`: [NetworkLoadBalancedTaskImageProps](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedTaskImageProps.html) = none — The properties required to create a new task definition.

  Only one of TaskDefinition or TaskImageOptions must be specified.

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) = uses the VPC defined in the cluster or creates a new VPC. — The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

  If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

  **Default:** uses the VPC defined in the cluster or creates a new VPC.

## Properties

- `cluster`: [ICluster](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ICluster.html) (required) — The cluster that hosts the service.

- `internalDesiredCount`: number — The desired number of instantiations of the task definition to keep running on the service.

  The default is 1 for all new services and uses the existing services desired count
  when updating an existing service, if one is not provided.

- `listener`: [NetworkListener](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.NetworkListener.html) (required) — - Use `listeners` instead.

- `listeners`: [NetworkListener](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.NetworkListener.html)[] (required) — The listeners of the service.

- `loadBalancer`: [NetworkLoadBalancer](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer.html) (required) — - Use `loadBalancers` instead.

- `loadBalancers`: [NetworkLoadBalancer](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer.html)[] (required) — The load balancers of the service.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `service`: [Ec2Service](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.Ec2Service.html) (required) — The EC2 service in this construct.

- `targetGroup`: [NetworkTargetGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup.html) (required) — - Use `targetGroups` instead.

- `targetGroups`: [NetworkTargetGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup.html)[] (required) — The target groups of the service.

- `taskDefinition`: [Ec2TaskDefinition](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.Ec2TaskDefinition.html) (required) — The EC2 Task Definition in this construct.

## Methods

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining