class NetworkLoadBalancedFargateService (construct)

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

Implements IConstruct, IConstruct, IDependable

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

Example

declare const cluster: ecs.Cluster;
const loadBalancedFargateService = new ecsPatterns.NetworkLoadBalancedFargateService(this, 'Service', {
  cluster,
  memoryLimitMiB: 1024,
  cpu: 512,
  taskImageOptions: {
    image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  },
});

Initializer

new NetworkLoadBalancedFargateService(scope: Construct, id: string, props?: NetworkLoadBalancedFargateServiceProps)

Parameters

scope Construct
id string
props NetworkLoadBalancedFargateServiceProps

Constructs a new instance of the NetworkLoadBalancedFargateService class.

Construct Props

Name	Type	Description
assignPublicIp?	`boolean`	Determines whether the service will be assigned a public IP address.
circuitBreaker?	`DeploymentCircuitBreaker`	Whether to enable the deployment circuit breaker.
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.
deploymentController?	`DeploymentController`	Specifies which deployment controller to use for the service.
desiredCount?	`number`	The desired number of instantiations of the task definition to keep running on the service.
domainName?	`string`	The domain name for the service, e.g. "api.example.com.".
domainZone?	`IHostedZone`	The Route53 hosted zone for the domain, e.g. "example.com.".
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.
listenerPort?	`number`	Listener port of the network load balancer that will serve traffic to the service.
loadBalancer?	`INetworkLoadBalancer`	The network load balancer that will serve traffic to the service.
maxHealthyPercent?	`number`	The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
memoryLimitMiB?	`number`	The amount (in MiB) of memory used by the task.
minHealthyPercent?	`number`	The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
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.
publicLoadBalancer?	`boolean`	Determines whether the Load Balancer will be internet-facing.
recordType?	`NetworkLoadBalancedServiceRecordType`	Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
serviceName?	`string`	The name of the service.
taskDefinition?	`FargateTaskDefinition`	The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
taskImageOptions?	`NetworkLoadBalancedTaskImageOptions`	The properties required to create a new task definition.
taskSubnets?	`SubnetSelection`	The subnets to associate with the service.
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.

circuitBreaker?

Type: DeploymentCircuitBreaker (optional, default: disabled)

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

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.

deploymentController?

Type: DeploymentController (optional, default: Rolling update (ECS))

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

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

domainName?

Type: string (optional, default: No domain name.)

The domain name for the service, e.g. "api.example.com.".

domainZone?

Type: IHostedZone (optional, default: No Route53 hosted domain zone.)

The Route53 hosted zone for the domain, e.g. "example.com.".

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.

listenerPort?

Type: number (optional, default: 80)

Listener port of the network load balancer that will serve traffic to the service.

loadBalancer?

Type: INetworkLoadBalancer (optional, default: a new load balancer will be created.)

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

If the load balancer has been imported, the vpc attribute must be specified in the call to fromNetworkLoadBalancerAttributes().

[disable-awslint:ref-via-interface]

maxHealthyPercent?

Type: number (optional, default: 100 if daemon, otherwise 200)

The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.

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.

minHealthyPercent?

Type: number (optional, default: 0 if daemon, otherwise 50)

The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.

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.

publicLoadBalancer?

Type: boolean (optional, default: true)

Determines whether the Load Balancer will be internet-facing.

recordType?

Type: NetworkLoadBalancedServiceRecordType (optional, default: NetworkLoadBalancedServiceRecordType.ALIAS)

Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.

This is useful if you need to work with DNS systems that do not support alias records.

serviceName?

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

The name of the service.

taskDefinition?

Type: FargateTaskDefinition (optional, default: none)

The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.

[disable-awslint:ref-via-interface]

taskImageOptions?

Type: NetworkLoadBalancedTaskImageOptions (optional, default: none)

The properties required to create a new task definition.

One of taskImageOptions or taskDefinition must be specified.

taskSubnets?

Type: SubnetSelection (optional, default: Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.)

The subnets to associate with the service.

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`
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 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.