interface ApplicationLoadBalancedFargateServiceProps

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.Patterns.ApplicationLoadBalancedFargateServiceProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#ApplicationLoadBalancedFargateServiceProps`
Java	`software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedFargateServiceProps`
Python	`aws_cdk.aws_ecs_patterns.ApplicationLoadBalancedFargateServiceProps`
TypeScript (source)	`aws-cdk-lib` » `aws_ecs_patterns` » `ApplicationLoadBalancedFargateServiceProps`

The properties for the ApplicationLoadBalancedFargateService service.

Example

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"),
  },
});

const scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount({
  minCapacity: 1,
  maxCapacity: 20,
});

scalableTarget.scaleOnCpuUtilization('CpuScaling', {
  targetUtilizationPercent: 50,
});

scalableTarget.scaleOnMemoryUtilization('MemoryScaling', {
  targetUtilizationPercent: 50,
});

Properties

Name	Type	Description
assignPublicIp?	`boolean`	Determines whether the service will be assigned a public IP address.
capacityProviderStrategies?	`CapacityProviderStrategy[]`	A list of Capacity Provider strategies used to place a service.
certificate?	`ICertificate`	Certificate Manager certificate to associate with the load balancer.
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.
enableExecuteCommand?	`boolean`	Whether ECS Exec should be enabled.
ephemeralStorageGiB?	`number`	The amount (in GiB) of ephemeral storage to be allocated to the task.
healthCheck?	`HealthCheck`	The health check command and associated configuration parameters for the container.
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.
idleTimeout?	`Duration`	The load balancer idle timeout, in seconds.
ipAddressType?	`IpAddressType`	The type of IP address to use.
listenerPort?	`number`	Listener port of the application load balancer that will serve traffic to the service.
loadBalancer?	`IApplicationLoadBalancer`	The application load balancer that will serve traffic to the service.
loadBalancerName?	`string`	Name of the load balancer.
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.
openListener?	`boolean`	Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
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.
protocol?	`ApplicationProtocol`	The protocol for connections from clients to the load balancer.
protocolVersion?	`ApplicationProtocolVersion`	The protocol version to use.
publicLoadBalancer?	`boolean`	Determines whether the Load Balancer will be internet-facing.
recordType?	`ApplicationLoadBalancedServiceRecordType`	Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
redirectHTTP?	`boolean`	Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.
runtimePlatform?	`RuntimePlatform`	The runtime platform of the task definition.
securityGroups?	`ISecurityGroup[]`	The security groups to associate with the service.
serviceName?	`string`	The name of the service.
sslPolicy?	`SslPolicy`	The security policy that defines which ciphers and protocols are supported by the ALB Listener.
targetProtocol?	`ApplicationProtocol`	The protocol for connections from the load balancer to the ECS tasks.
taskDefinition?	`FargateTaskDefinition`	The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
taskImageOptions?	`ApplicationLoadBalancedTaskImageOptions`	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.

capacityProviderStrategies?

Type: CapacityProviderStrategy[] (optional, default: undefined)

A list of Capacity Provider strategies used to place a service.

certificate?

Type: ICertificate (optional, 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.)

Certificate Manager certificate to associate with the load balancer.

Setting this option will set the load balancer protocol to HTTPS.

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

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?

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: 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

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

enableExecuteCommand?

Type: boolean (optional, default: false)

Whether ECS Exec should be enabled.

ephemeralStorageGiB?

Type: number (optional, default: Undefined, in which case, the task will receive 20GiB ephemeral storage.)

The amount (in GiB) of ephemeral storage to be allocated to the task.

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?

Type: HealthCheck (optional, default: Health check configuration from container.)

The health check command and associated configuration parameters for the container.

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.

idleTimeout?

Type: Duration (optional, default: CloudFormation sets idle timeout to 60 seconds)

The load balancer idle timeout, in seconds.

Can be between 1 and 4000 seconds

ipAddressType?

Type: IpAddressType (optional, default: IpAddressType.IPV4)

The type of IP address to use.

listenerPort?

Type: number (optional, 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.)

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

loadBalancer?

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

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

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?

Type: string (optional, default: Automatically generated name.)

Name of the load balancer.

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)

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?

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.

openListener?

Type: boolean (optional, default: true -- The security group allows ingress from all IP addresses.)

Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.

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.

protocol?

Type: ApplicationProtocol (optional, default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.)

The protocol for connections from clients to the load balancer.

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?

Type: ApplicationProtocolVersion (optional, default: ApplicationProtocolVersion.HTTP1)

The protocol version to use.

publicLoadBalancer?

Type: boolean (optional, default: true)

Determines whether the Load Balancer will be internet-facing.

recordType?

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

redirectHTTP?

Type: boolean (optional, default: false)

Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.

runtimePlatform?

Type: RuntimePlatform (optional, default: If the property is undefined, operatingSystemFamily is LINUX and cpuArchitecture is X86_64)

The runtime platform of the task definition.

securityGroups?

Type: ISecurityGroup[] (optional, default: A new security group is created.)

The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

serviceName?

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

The name of the service.

sslPolicy?

Type: SslPolicy (optional, default: The recommended elastic load balancing security policy)

The security policy that defines which ciphers and protocols are supported by the ALB Listener.

targetProtocol?

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

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: ApplicationLoadBalancedTaskImageOptions (optional, default: none)

The properties required to create a new task definition.

TaskDefinition or TaskImageOptions must be specified, but not both.

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.