ApplicationLoadBalancedFargateService L3 construct
A Fargate service running on an ECS cluster fronted by an application load balancer.
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"),
},
minHealthyPercent: 100,
});
const scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount({
minCapacity: 1,
maxCapacity: 20,
});
scalableTarget.scaleOnCpuUtilization('CpuScaling', {
targetUtilizationPercent: 50,
});
scalableTarget.scaleOnMemoryUtilization('MemoryScaling', {
targetUtilizationPercent: 50,
});
# cluster: ecs.Cluster
load_balanced_fargate_service = ecs_patterns.ApplicationLoadBalancedFargateService(self, "Service",
cluster=cluster,
memory_limit_mi_b=1024,
desired_count=1,
cpu=512,
task_image_options=ecsPatterns.ApplicationLoadBalancedTaskImageOptions(
image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample")
),
min_healthy_percent=100
)
scalable_target = load_balanced_fargate_service.service.auto_scale_task_count(
min_capacity=1,
max_capacity=20
)
scalable_target.scale_on_cpu_utilization("CpuScaling",
target_utilization_percent=50
)
scalable_target.scale_on_memory_utilization("MemoryScaling",
target_utilization_percent=50
)
Cluster cluster;
ApplicationLoadBalancedFargateService loadBalancedFargateService = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
.cluster(cluster)
.memoryLimitMiB(1024)
.desiredCount(1)
.cpu(512)
.taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
.image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
.build())
.minHealthyPercent(100)
.build();
ScalableTaskCount scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount(EnableScalingProps.builder()
.minCapacity(1)
.maxCapacity(20)
.build());
scalableTarget.scaleOnCpuUtilization("CpuScaling", CpuUtilizationScalingProps.builder()
.targetUtilizationPercent(50)
.build());
scalableTarget.scaleOnMemoryUtilization("MemoryScaling", MemoryUtilizationScalingProps.builder()
.targetUtilizationPercent(50)
.build());
// Install: dotnet add package Amazon.CDK.Lib
Cluster cluster;
var loadBalancedFargateService = new ApplicationLoadBalancedFargateService(this, "Service", new ApplicationLoadBalancedFargateServiceProps {
Cluster = cluster,
MemoryLimitMiB = 1024,
DesiredCount = 1,
Cpu = 512,
TaskImageOptions = new ApplicationLoadBalancedTaskImageOptions {
Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample")
},
MinHealthyPercent = 100
});
var scalableTarget = loadBalancedFargateService.Service.AutoScaleTaskCount(new EnableScalingProps {
MinCapacity = 1,
MaxCapacity = 20
});
scalableTarget.ScaleOnCpuUtilization("CpuScaling", new CpuUtilizationScalingProps {
TargetUtilizationPercent = 50
});
scalableTarget.ScaleOnMemoryUtilization("MemoryScaling", new MemoryUtilizationScalingProps {
TargetUtilizationPercent = 50
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var cluster Cluster
loadBalancedFargateService := ecsPatterns.NewApplicationLoadBalancedFargateService(this, jsii.String("Service"), &ApplicationLoadBalancedFargateServiceProps{
Cluster: Cluster,
MemoryLimitMiB: jsii.Number(1024),
DesiredCount: jsii.Number(1),
Cpu: jsii.Number(512),
TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{
Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")),
},
MinHealthyPercent: jsii.Number(100),
})
scalableTarget := loadBalancedFargateService.Service.AutoScaleTaskCount(&EnableScalingProps{
MinCapacity: jsii.Number(1),
MaxCapacity: jsii.Number(20),
})
scalableTarget.ScaleOnCpuUtilization(jsii.String("CpuScaling"), &CpuUtilizationScalingProps{
TargetUtilizationPercent: jsii.Number(50),
})
scalableTarget.ScaleOnMemoryUtilization(jsii.String("MemoryScaling"), &MemoryUtilizationScalingProps{
TargetUtilizationPercent: jsii.Number(50),
})
Initializer
new ApplicationLoadBalancedFargateService(scope: Construct, id: string, props?: ApplicationLoadBalancedFargateServiceProps)
ApplicationLoadBalancedFargateService(scope: Construct, id: str, props: typing.Optional[ApplicationLoadBalancedFargateServiceProps] = None)
new ApplicationLoadBalancedFargateService(Construct scope, String id, ApplicationLoadBalancedFargateServiceProps props)
new ApplicationLoadBalancedFargateService(Construct scope, string id, ApplicationLoadBalancedFargateServiceProps? props = null)
NewApplicationLoadBalancedFargateService(Scope Construct, Id *string, Props ApplicationLoadBalancedFargateServiceProps)
Construct Props
assignPublicIpbooleanassign_public_ipboolassignPublicIpBooleanAssignPublicIpboolAssignPublicIp*bool= false#capacityProviderStrategiesCapacityProviderStrategy[]capacity_provider_strategiestyping.List[CapacityProviderStrategy]capacityProviderStrategiesList<CapacityProviderStrategy>CapacityProviderStrategiesCapacityProviderStrategy[]CapacityProviderStrategies*[]CapacityProviderStrategy= undefined#certificateICertificatecertificateICertificatecertificateICertificateCertificateICertificateCertificateICertificate= No certificate associated with t…#Setting this option will set the load balancer protocol to HTTPS.
default
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.
circuitBreakerDeploymentCircuitBreakercircuit_breakerDeploymentCircuitBreakercircuitBreakerDeploymentCircuitBreakerCircuitBreakerDeploymentCircuitBreakerCircuitBreakerDeploymentCircuitBreaker= disabled#If this property is defined, circuit breaker will be implicitly enabled.
cloudMapOptionsCloudMapOptionscloud_map_optionsCloudMapOptionscloudMapOptionsCloudMapOptionsCloudMapOptionsCloudMapOptionsCloudMapOptionsCloudMapOptions= AWS Cloud Map service discovery …#default
Default: AWS Cloud Map service discovery is not enabled.
clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterICluster= create a new cluster; if both cl…#If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
default
Default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
containerCpunumbercontainer_cpuint | floatcontainerCpuNumberContainerCpudoubleContainerCpu*float64= No minimum CPU units reserved.#containerMemoryLimitMiBnumbercontainer_memory_limit_mi_bint | floatcontainerMemoryLimitMiBNumberContainerMemoryLimitMiBdoubleContainerMemoryLimitMiB*float64= No memory limit.#If your container attempts to exceed the allocated memory, the container is terminated.
notes
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.
deploymentControllerDeploymentControllerdeployment_controllerDeploymentControllerdeploymentControllerDeploymentControllerDeploymentControllerDeploymentControllerDeploymentControllerDeploymentController= Rolling update (ECS)#For more information, see Amazon ECS Deployment Types
desiredCountnumberdesired_countint | floatdesiredCountNumberDesiredCountdoubleDesiredCount*float64= The default is 1 for all new ser…#The minimum value is 1
default
Default: The default is 1 for all new services and uses the existing service's desired count when updating an existing service.
domainZoneIHostedZonedomain_zoneIHostedZonedomainZoneIHostedZoneDomainZoneIHostedZoneDomainZoneIHostedZone= No Route53 hosted domain zone.#enableECSManagedTagsbooleanenable_ecs_managed_tagsboolenableECSManagedTagsBooleanEnableECSManagedTagsboolEnableECSManagedTags*bool= false#For more information, see Tagging Your Amazon ECS Resources
enableExecuteCommandbooleanenable_execute_commandboolenableExecuteCommandBooleanEnableExecuteCommandboolEnableExecuteCommand*bool= false#ephemeralStorageGiBnumberephemeral_storage_gi_bint | floatephemeralStorageGiBNumberEphemeralStorageGiBdoubleEphemeralStorageGiB*float64= Undefined, in which case, the ta…#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.
default
Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.
healthCheckHealthCheckhealth_checkHealthCheckhealthCheckHealthCheckHealthCheckHealthCheckHealthCheckHealthCheck= Health check configuration from …#default
Default: Health check configuration from container.
healthCheckGracePeriodDurationhealth_check_grace_periodDurationhealthCheckGracePeriodDurationHealthCheckGracePeriodDurationHealthCheckGracePeriodDuration= defaults to 60 seconds if at lea…#default
Default: defaults to 60 seconds if at least one load balancer is in-use and it is not already set
idleTimeoutDurationidle_timeoutDurationidleTimeoutDurationIdleTimeoutDurationIdleTimeoutDuration= CloudFormation sets idle timeout…#Can be between 1 and 4000 seconds
default
Default: CloudFormation sets idle timeout to 60 seconds
ipAddressTypeIpAddressTypeip_address_typeIpAddressTypeipAddressTypeIpAddressTypeIpAddressTypeIpAddressTypeIpAddressTypeIpAddressType= IpAddressType.IPV4#listenerPortnumberlistener_portint | floatlistenerPortNumberListenerPortdoubleListenerPort*float64= The default listener port is det…#default
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.
loadBalancerIApplicationLoadBalancerload_balancerIApplicationLoadBalancerloadBalancerIApplicationLoadBalancerLoadBalancerIApplicationLoadBalancerLoadBalancerIApplicationLoadBalancer= a new load balancer will be crea…#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]
default
Default: a new load balancer will be created.
loadBalancerNamestringload_balancer_namestrloadBalancerNameStringLoadBalancerNamestringLoadBalancerName*string= Automatically generated name.#maxHealthyPercentnumbermax_healthy_percentint | floatmaxHealthyPercentNumberMaxHealthyPercentdoubleMaxHealthyPercent*float64= 100 if daemon, otherwise 200#memoryLimitMiBnumbermemory_limit_mi_bint | floatmemoryLimitMiBNumberMemoryLimitMiBdoubleMemoryLimitMiB*float64= 512#notes
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.
minHealthyPercentnumbermin_healthy_percentint | floatminHealthyPercentNumberMinHealthyPercentdoubleMinHealthyPercent*float64= 0 if daemon, otherwise 50#openListenerbooleanopen_listenerboolopenListenerBooleanOpenListenerboolOpenListener*bool= true -- The security group allow…#default
Default: true -- The security group allows ingress from all IP addresses.
platformVersionFargatePlatformVersionplatform_versionFargatePlatformVersionplatformVersionFargatePlatformVersionPlatformVersionFargatePlatformVersionPlatformVersionFargatePlatformVersion= Latest#notes
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.
propagateTagsPropagatedTagSourcepropagate_tagsPropagatedTagSourcepropagateTagsPropagatedTagSourcePropagateTagsPropagatedTagSourcePropagateTagsPropagatedTagSource= none#Tags can only be propagated to the tasks within the service during service creation.
protocolApplicationProtocolprotocolApplicationProtocolprotocolApplicationProtocolProtocolApplicationProtocolProtocolApplicationProtocol= HTTP. If a certificate is specif…#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.
default
Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.
protocolVersionApplicationProtocolVersionprotocol_versionApplicationProtocolVersionprotocolVersionApplicationProtocolVersionProtocolVersionApplicationProtocolVersionProtocolVersionApplicationProtocolVersion= ApplicationProtocolVersion.HTTP1#publicLoadBalancerbooleanpublic_load_balancerboolpublicLoadBalancerBooleanPublicLoadBalancerboolPublicLoadBalancer*bool= true#recordTypeApplicationLoadBalancedServiceRecordTyperecord_typeApplicationLoadBalancedServiceRecordTyperecordTypeApplicationLoadBalancedServiceRecordTypeRecordTypeApplicationLoadBalancedServiceRecordTypeRecordTypeApplicationLoadBalancedServiceRecordType= ApplicationLoadBalancedServiceRe…#This is useful if you need to work with DNS systems that do not support alias records.
default
Default: ApplicationLoadBalancedServiceRecordType.ALIAS
This is only valid if the protocol of the ALB is HTTPS.
runtimePlatformRuntimePlatformruntime_platformRuntimePlatformruntimePlatformRuntimePlatformRuntimePlatformRuntimePlatformRuntimePlatformRuntimePlatform= If the property is undefined, `o…#default
Default: If the property is undefined, operatingSystemFamily is LINUX and cpuArchitecture is X86_64
securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= A new security group is created.#If you do not specify a security group, a new security group is created.
serviceNamestringservice_namestrserviceNameStringServiceNamestringServiceName*string= CloudFormation-generated name.#sslPolicySslPolicyssl_policySslPolicysslPolicySslPolicySslPolicySslPolicySslPolicySslPolicy= The recommended elastic load bal…#default
Default: The recommended elastic load balancing security policy
targetProtocolApplicationProtocoltarget_protocolApplicationProtocoltargetProtocolApplicationProtocolTargetProtocolApplicationProtocolTargetProtocolApplicationProtocol= HTTP.#The default target port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS).
taskDefinitionFargateTaskDefinitiontask_definitionFargateTaskDefinitiontaskDefinitionFargateTaskDefinitionTaskDefinitionFargateTaskDefinitionTaskDefinitionFargateTaskDefinition= none#[disable-awslint:ref-via-interface]
taskImageOptionsApplicationLoadBalancedTaskImageOptionstask_image_optionsApplicationLoadBalancedTaskImageOptionstaskImageOptionsApplicationLoadBalancedTaskImageOptionsTaskImageOptionsApplicationLoadBalancedTaskImageOptionsTaskImageOptionsApplicationLoadBalancedTaskImageOptions= none#TaskDefinition or TaskImageOptions must be specified, but not both.
taskSubnetsSubnetSelectiontask_subnetsSubnetSelectiontaskSubnetsSubnetSelectionTaskSubnetsSubnetSelectionTaskSubnetsSubnetSelection= Public subnets if `assignPublicI…#default
Default: Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.
If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.
default
Default: uses the VPC defined in the cluster or creates a new VPC.
Properties
assignPublicIpbooleanassign_public_ipboolassignPublicIpBooleanAssignPublicIpboolAssignPublicIp*boolrequired#certificateICertificatecertificateICertificatecertificateICertificateCertificateICertificateCertificateICertificate#internalDesiredCountnumberinternal_desired_countint | floatinternalDesiredCountNumberInternalDesiredCountdoubleInternalDesiredCount*float64#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.
listenerApplicationListenerlistenerApplicationListenerlistenerApplicationListenerListenerApplicationListenerListenerApplicationListenerrequired#loadBalancerApplicationLoadBalancerload_balancerApplicationLoadBalancerloadBalancerApplicationLoadBalancerLoadBalancerApplicationLoadBalancerLoadBalancerApplicationLoadBalancerrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#redirectListenerApplicationListenerredirect_listenerApplicationListenerredirectListenerApplicationListenerRedirectListenerApplicationListenerRedirectListenerApplicationListener#serviceFargateServiceserviceFargateServiceserviceFargateServiceServiceFargateServiceServiceFargateServicerequired#targetGroupApplicationTargetGrouptarget_groupApplicationTargetGrouptargetGroupApplicationTargetGroupTargetGroupApplicationTargetGroupTargetGroupApplicationTargetGrouprequired#taskDefinitionFargateTaskDefinitiontask_definitionFargateTaskDefinitiontaskDefinitionFargateTaskDefinitionTaskDefinitionFargateTaskDefinitionTaskDefinitionFargateTaskDefinitionrequired#Methods
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining