# ApplicationLoadBalancedFargateServiceProps The properties for the ApplicationLoadBalancedFargateService service. Extends: ApplicationLoadBalancedFargateServiceProps Extends: ApplicationLoadBalancedServiceBaseProps, FargateServiceBaseProps Used as props by: ApplicationLoadBalancedFargateService - Source: [`aws-ecs-patterns/lib/fargate/application-load-balanced-fargate-service.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-ecs-patterns/lib/fargate/application-load-balanced-fargate-service.ts#L15) - Type last changed: v2.178.0 · 6 Feb 2025 ## Example ```ts declare const cluster: ecs.Cluster; const loadBalancedFargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, 'Service', { cluster, memoryLimitMiB: 1024, desiredCount: 1, cpu: 512, taskImageOptions: { image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"), }, minHealthyPercent: 100, }); const scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount({ minCapacity: 1, maxCapacity: 20, }); scalableTarget.scaleOnCpuUtilization('CpuScaling', { targetUtilizationPercent: 50, }); scalableTarget.scaleOnMemoryUtilization('MemoryScaling', { targetUtilizationPercent: 50, }); ``` ## Properties - `assignPublicIp`: boolean = false — Determines whether the service will be assigned a public IP address. - `capacityProviderStrategies`: [CapacityProviderStrategy](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.CapacityProviderStrategy.html)[] = undefined — A list of Capacity Provider strategies used to place a service. - `certificate`: [ICertificate](/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.ICertificate.html) — Certificate Manager certificate to associate with the load balancer. **Default:** No certificate associated with the load balancer, if using the HTTP protocol. For HTTPS, a DNS-validated certificate will be created for the load balancer's specified domain name if a domain name and domain zone are specified. Setting this option will set the load balancer protocol to HTTPS. - `circuitBreaker`: [DeploymentCircuitBreaker](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.DeploymentCircuitBreaker.html) = disabled — Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled. - `cloudMapOptions`: [CloudMapOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.CloudMapOptions.html) — 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) — The name of the cluster that hosts the service. **Default:** create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you. If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc. - `containerCpu`: number — The minimum number of CPU units to reserve for the container. **Default:** No minimum CPU units reserved. - `containerMemoryLimitMiB`: number — The amount (in MiB) of memory to present to the container. **Default:** No memory limit. If your container attempts to exceed the allocated memory, the container is terminated. - `cpu`: number = 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 8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments 16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments This default is set in the underlying FargateTaskDefinition construct. - `deploymentController`: [DeploymentController](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.DeploymentController.html) — Specifies which deployment controller to use for the service. **Default:** Rolling update (ECS) For more information, see [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) - `desiredCount`: number — The desired number of instantiations of the task definition to keep running on the service. **Default:** The default is 1 for all new services and uses the existing service's desired count when updating an existing service. The minimum value is 1 - `domainName`: string — The domain name for the service, e.g. "api.example.com.". **Default:** No domain name. - `domainZone`: [IHostedZone](/cdk/api/v2/docs/aws-cdk-lib.aws_route53.IHostedZone.html) — The Route53 hosted zone for the domain, e.g. "example.com.". **Default:** No Route53 hosted domain zone. - `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. - `ephemeralStorageGiB`: number — The amount (in GiB) of ephemeral storage to be allocated to the task. **Default:** Undefined, in which case, the task will receive 20GiB ephemeral storage. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB. Only supported in Fargate platform version 1.4.0 or later. - `healthCheck`: [HealthCheck](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.HealthCheck.html) — The health check command and associated configuration parameters for the container. **Default:** Health check configuration from container. - `healthCheckGracePeriod`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — 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 - `idleTimeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — The load balancer idle timeout, in seconds. **Default:** CloudFormation sets idle timeout to 60 seconds Can be between 1 and 4000 seconds - `ipAddressType`: [IpAddressType](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.IpAddressType.html) = IpAddressType.IPV4 — The type of IP address to use. - `listenerPort`: number — Listener port of the application load balancer that will serve traffic to the service. **Default:** The default listener port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS. - `loadBalancer`: [IApplicationLoadBalancer](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer.html) — The application load balancer that will serve traffic to the service. **Default:** a new load balancer will be created. The VPC attribute of a load balancer must be specified for it to be used to create a new service with this pattern. [disable-awslint:ref-via-interface] - `loadBalancerName`: string — Name of the load balancer. **Default:** Automatically generated name. - `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. **Default:** 100 if daemon, otherwise 200 - `memoryLimitMiB`: number = 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) Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU) Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU) This default is set in the underlying FargateTaskDefinition construct. - `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. **Default:** 0 if daemon, otherwise 50 - `openListener`: boolean — Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default. **Default:** true -- The security group allows ingress from all IP addresses. - `platformVersion`: [FargatePlatformVersion](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargatePlatformVersion.html) = 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the Amazon Elastic Container Service Developer Guide. - `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. - `protocol`: [ApplicationProtocol](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol.html) — The protocol for connections from clients to the load balancer. **Default:** HTTP. If a certificate is specified, the protocol will be set by default to HTTPS. The load balancer port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). If HTTPS, either a certificate or domain name and domain zone must also be specified. - `protocolVersion`: [ApplicationProtocolVersion](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion.html) = ApplicationProtocolVersion.HTTP1 — The protocol version to use. - `publicLoadBalancer`: boolean = true — Determines whether the Load Balancer will be internet-facing. - `recordType`: [ApplicationLoadBalancedServiceRecordType](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedServiceRecordType.html) — Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. **Default:** ApplicationLoadBalancedServiceRecordType.ALIAS This is useful if you need to work with DNS systems that do not support alias records. - `redirectHTTP`: boolean = false — Specifies whether the load balancer should redirect traffic on port 80 to the {@link listenerPort} to support HTTP->HTTPS redirects. This is only valid if the protocol of the ALB is HTTPS. - `runtimePlatform`: [RuntimePlatform](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.RuntimePlatform.html) — The runtime platform of the task definition. **Default:** If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64 - `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] — The security groups to associate with the service. **Default:** A new security group is created. If you do not specify a security group, a new security group is created. - `serviceName`: string — The name of the service. **Default:** CloudFormation-generated name. - `sslPolicy`: [SslPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.SslPolicy.html) — The security policy that defines which ciphers and protocols are supported by the ALB Listener. **Default:** The recommended elastic load balancing security policy - `targetProtocol`: [ApplicationProtocol](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol.html) = HTTP. — The protocol for connections from the load balancer to the ECS tasks. The default target port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). - `taskDefinition`: [FargateTaskDefinition](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinition.html) = 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`: [ApplicationLoadBalancedTaskImageOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedTaskImageOptions.html) = none — The properties required to create a new task definition. TaskDefinition or TaskImageOptions must be specified, but not both. - `taskSubnets`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html) — The subnets to associate with the service. **Default:** Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order. - `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) — The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. **Default:** uses the VPC defined in the cluster or creates a new VPC. If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.