class NetworkMultipleTargetGroupsFargateService (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.Patterns.NetworkMultipleTargetGroupsFargateService`
Java	`software.amazon.awscdk.services.ecs.patterns.NetworkMultipleTargetGroupsFargateService`
Python	`aws_cdk.aws_ecs_patterns.NetworkMultipleTargetGroupsFargateService`
TypeScript (source)	`@aws-cdk/aws-ecs-patterns` » `NetworkMultipleTargetGroupsFargateService`

Implements IConstruct, IConstruct, IDependable

A Fargate service running on an ECS cluster fronted by a network load balancer.

Example

// Two network load balancers, each with their own listener and target group.
declare const cluster: ecs.Cluster;
const loadBalancedFargateService = new ecsPatterns.NetworkMultipleTargetGroupsFargateService(this, 'Service', {
  cluster,
  memoryLimitMiB: 512,
  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

new NetworkMultipleTargetGroupsFargateService(scope: Construct, id: string, props?: NetworkMultipleTargetGroupsFargateServiceProps)

Parameters

scope Construct
id string
props NetworkMultipleTargetGroupsFargateServiceProps

Constructs a new instance of the NetworkMultipleTargetGroupsFargateService class.

Construct Props

Name	Type	Description
assignPublicIp?	`boolean`	Determines whether the service will be assigned a public IP address.
cloudMapOptions?	`CloudMapOptions`	The options for configuring an Amazon ECS service to use service discovery.
cluster?	`ICluster`	The name of the cluster that hosts the service.
cpu?	`number`	The number of cpu units used by the task.
desiredCount?	`number`	The desired number of instantiations of the task definition to keep running on the service.
enableECSManagedTags?	`boolean`	Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
healthCheckGracePeriod?	`Duration`	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.
loadBalancers?	`NetworkLoadBalancerProps[]`	The network load balancer that will serve traffic to the service.
memoryLimitMiB?	`number`	The amount (in MiB) of memory used by the task.
platformVersion?	`FargatePlatformVersion`	The platform version on which to run your service.
propagateTags?	`PropagatedTagSource`	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
serviceName?	`string`	Name of the service.
targetGroups?	`NetworkTargetProps[]`	Properties to specify NLB target groups.
taskDefinition?	`FargateTaskDefinition`	The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.
taskImageOptions?	`NetworkLoadBalancedTaskImageProps`	The properties required to create a new task definition.
vpc?	`IVpc`	The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

assignPublicIp?

Type: boolean (optional, default: false)

Determines whether the service will be assigned a public IP address.

cloudMapOptions?

Type: CloudMapOptions (optional, default: AWS Cloud Map service discovery is not enabled.)

The options for configuring an Amazon ECS service to use service discovery.

cluster?

Type: ICluster (optional, default: 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.

cpu?

Type: number (optional, default: 256)

The number of cpu units used by the task.

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

256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

This default is set in the underlying FargateTaskDefinition construct.

desiredCount?

Type: number (optional, default: If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the default is 1 for all new services and uses the existing services 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

enableECSManagedTags?

Type: boolean (optional, default: false)

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

healthCheckGracePeriod?

Type: Duration (optional, default: 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.

loadBalancers?

Type: NetworkLoadBalancerProps[] (optional, default: a new load balancer with a listener will be created.)

The network load balancer that will serve traffic to the service.

memoryLimitMiB?

Type: number (optional, default: 512)

The amount (in MiB) of memory used by the task.

This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

platformVersion?

Type: FargatePlatformVersion (optional, default: Latest)

The platform version on which to run your service.

If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

propagateTags?

Type: PropagatedTagSource (optional, default: 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?

Type: string (optional, default: CloudFormation-generated name.)

Name of the service.

targetGroups?

Type: NetworkTargetProps[] (optional, default: default portMapping registered as target group and attached to the first defined listener)

Properties to specify NLB target groups.

taskDefinition?

Type: FargateTaskDefinition (optional, default: 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?

Type: NetworkLoadBalancedTaskImageProps (optional, default: none)

The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

vpc?

Type: IVpc (optional, default: 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.

Properties

Name	Type	Description
assignPublicIp	`boolean`	Determines whether the service will be assigned a public IP address.
cluster	`ICluster`	The cluster that hosts the service.
desiredCount⚠️	`number`	The desired number of instantiations of the task definition to keep running on the service.
listener	`NetworkListener`	The listener for the service.
loadBalancer	`NetworkLoadBalancer`	The Network Load Balancer for the service.
node	`ConstructNode`	The construct tree node associated with this construct.
service	`FargateService`	The Fargate service in this construct.
targetGroup	`NetworkTargetGroup`	The default target group for the service.
taskDefinition	`FargateTaskDefinition`	The Fargate task definition in this construct.
internalDesiredCount?	`number`	The desired number of instantiations of the task definition to keep running on the service.