ApplicationLoadBalancedEc2Service L3 construct
An EC2 service running on an ECS cluster fronted by an application load balancer.
Example
declare const cluster: ecs.Cluster;
const loadBalancedEcsService = new ecsPatterns.ApplicationLoadBalancedEc2Service(this, 'Service', {
cluster,
memoryLimitMiB: 1024,
taskImageOptions: {
image: ecs.ContainerImage.fromRegistry('test'),
environment: {
TEST_ENVIRONMENT_VARIABLE1: "test environment variable 1 value",
TEST_ENVIRONMENT_VARIABLE2: "test environment variable 2 value",
},
command: ['command'],
entryPoint: ['entry', 'point'],
},
desiredCount: 2,
minHealthyPercent: 100,
});
# cluster: ecs.Cluster
load_balanced_ecs_service = ecs_patterns.ApplicationLoadBalancedEc2Service(self, "Service",
cluster=cluster,
memory_limit_mi_b=1024,
task_image_options=ecsPatterns.ApplicationLoadBalancedTaskImageOptions(
image=ecs.ContainerImage.from_registry("test"),
environment={
"TEST_ENVIRONMENT_VARIABLE1": "test environment variable 1 value",
"TEST_ENVIRONMENT_VARIABLE2": "test environment variable 2 value"
},
command=["command"],
entry_point=["entry", "point"]
),
desired_count=2,
min_healthy_percent=100
)
Cluster cluster;
ApplicationLoadBalancedEc2Service loadBalancedEcsService = ApplicationLoadBalancedEc2Service.Builder.create(this, "Service")
.cluster(cluster)
.memoryLimitMiB(1024)
.taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
.image(ContainerImage.fromRegistry("test"))
.environment(Map.of(
"TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
"TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
.command(List.of("command"))
.entryPoint(List.of("entry", "point"))
.build())
.desiredCount(2)
.minHealthyPercent(100)
.build();
// Install: dotnet add package Amazon.CDK.Lib
Cluster cluster;
var loadBalancedEcsService = new ApplicationLoadBalancedEc2Service(this, "Service", new ApplicationLoadBalancedEc2ServiceProps {
Cluster = cluster,
MemoryLimitMiB = 1024,
TaskImageOptions = new ApplicationLoadBalancedTaskImageOptions {
Image = ContainerImage.FromRegistry("test"),
Environment = new Dictionary<string, string> {
{ "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value" },
{ "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value" }
},
Command = new [] { "command" },
EntryPoint = new [] { "entry", "point" }
},
DesiredCount = 2,
MinHealthyPercent = 100
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var cluster Cluster
loadBalancedEcsService := ecsPatterns.NewApplicationLoadBalancedEc2Service(this, jsii.String("Service"), &ApplicationLoadBalancedEc2ServiceProps{
Cluster: Cluster,
MemoryLimitMiB: jsii.Number(1024),
TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{
Image: ecs.ContainerImage_FromRegistry(jsii.String("test")),
Environment: map[string]*string{
"TEST_ENVIRONMENT_VARIABLE1": jsii.String("test environment variable 1 value"),
"TEST_ENVIRONMENT_VARIABLE2": jsii.String("test environment variable 2 value"),
},
Command: []*string{
jsii.String("command"),
},
EntryPoint: []*string{
jsii.String("entry"),
jsii.String("point"),
},
},
DesiredCount: jsii.Number(2),
MinHealthyPercent: jsii.Number(100),
})
Initializer
new ApplicationLoadBalancedEc2Service(scope: Construct, id: string, props?: ApplicationLoadBalancedEc2ServiceProps)
ApplicationLoadBalancedEc2Service(scope: Construct, id: str, props: typing.Optional[ApplicationLoadBalancedEc2ServiceProps] = None)
new ApplicationLoadBalancedEc2Service(Construct scope, String id, ApplicationLoadBalancedEc2ServiceProps props)
new ApplicationLoadBalancedEc2Service(Construct scope, string id, ApplicationLoadBalancedEc2ServiceProps? props = null)
NewApplicationLoadBalancedEc2Service(Scope Construct, Id *string, Props ApplicationLoadBalancedEc2ServiceProps)
Construct Props
capacityProviderStrategiesoptionalCapacityProviderStrategy[]capacity_provider_strategiesoptionaltyping.List[CapacityProviderStrategy]capacityProviderStrategiesoptionalList<CapacityProviderStrategy>CapacityProviderStrategiesoptionalCapacityProviderStrategy[]CapacityProviderStrategiesoptional*[]CapacityProviderStrategy= undefined#certificateoptionalICertificatecertificateoptionalICertificatecertificateoptionalICertificateCertificateoptionalICertificateCertificateoptionalICertificate#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.
circuitBreakeroptionalDeploymentCircuitBreakercircuit_breakeroptionalDeploymentCircuitBreakercircuitBreakeroptionalDeploymentCircuitBreakerCircuitBreakeroptionalDeploymentCircuitBreakerCircuitBreakeroptionalDeploymentCircuitBreaker= disabled#If this property is defined, circuit breaker will be implicitly enabled.
cloudMapOptionsoptionalCloudMapOptionscloud_map_optionsoptionalCloudMapOptionscloudMapOptionsoptionalCloudMapOptionsCloudMapOptionsoptionalCloudMapOptionsCloudMapOptionsoptionalCloudMapOptions#Default: AWS Cloud Map service discovery is not enabled.
clusteroptionalIClusterclusteroptionalIClusterclusteroptionalIClusterClusteroptionalIClusterClusteroptionalICluster#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.
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
This default is set in the underlying FargateTaskDefinition construct.
deploymentControlleroptionalDeploymentControllerdeployment_controlleroptionalDeploymentControllerdeploymentControlleroptionalDeploymentControllerDeploymentControlleroptionalDeploymentControllerDeploymentControlleroptionalDeploymentController#Default: Rolling update (ECS)
For more information, see Amazon ECS Deployment Types
desiredCountoptionalnumberdesired_countoptionalint | floatdesiredCountoptionalNumberDesiredCountoptionaldoubleDesiredCountoptional*float64#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
domainNameoptionalstringdomain_nameoptionalstrdomainNameoptionalStringDomainNameoptionalstringDomainNameoptional*string#Default: No domain name.
domainZoneoptionalIHostedZonedomain_zoneoptionalIHostedZonedomainZoneoptionalIHostedZoneDomainZoneoptionalIHostedZoneDomainZoneoptionalIHostedZone#Default: No Route53 hosted domain zone.
enableECSManagedTagsoptionalbooleanenable_ecs_managed_tagsoptionalboolenableECSManagedTagsoptionalBooleanEnableECSManagedTagsoptionalboolEnableECSManagedTagsoptional*bool= false#For more information, see Tagging Your Amazon ECS Resources
enableExecuteCommandoptionalbooleanenable_execute_commandoptionalboolenableExecuteCommandoptionalBooleanEnableExecuteCommandoptionalboolEnableExecuteCommandoptional*bool= false#healthCheckGracePeriodoptionalDurationhealth_check_grace_periodoptionalDurationhealthCheckGracePeriodoptionalDurationHealthCheckGracePeriodoptionalDurationHealthCheckGracePeriodoptionalDuration#Default: defaults to 60 seconds if at least one load balancer is in-use and it is not already set
idleTimeoutoptionalDurationidle_timeoutoptionalDurationidleTimeoutoptionalDurationIdleTimeoutoptionalDurationIdleTimeoutoptionalDuration#Default: CloudFormation sets idle timeout to 60 seconds
Can be between 1 and 4000 seconds
ipAddressTypeoptionalIpAddressTypeip_address_typeoptionalIpAddressTypeipAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressType= IpAddressType.IPV4#listenerPortoptionalnumberlistener_portoptionalint | floatlistenerPortoptionalNumberListenerPortoptionaldoubleListenerPortoptional*float64#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.
loadBalanceroptionalIApplicationLoadBalancerload_balanceroptionalIApplicationLoadBalancerloadBalanceroptionalIApplicationLoadBalancerLoadBalanceroptionalIApplicationLoadBalancerLoadBalanceroptionalIApplicationLoadBalancer#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]
loadBalancerNameoptionalstringload_balancer_nameoptionalstrloadBalancerNameoptionalStringLoadBalancerNameoptionalstringLoadBalancerNameoptional*string#Default: Automatically generated name.
maxHealthyPercentoptionalnumbermax_healthy_percentoptionalint | floatmaxHealthyPercentoptionalNumberMaxHealthyPercentoptionaldoubleMaxHealthyPercentoptional*float64#Default: 100 if daemon, otherwise 200
memoryLimitMiBoptionalnumbermemory_limit_mi_boptionalint | floatmemoryLimitMiBoptionalNumberMemoryLimitMiBoptionaldoubleMemoryLimitMiBoptional*float64#Default: No memory limit.
If your container attempts to exceed the allocated memory, the container is terminated.
At least one of memoryLimitMiB and memoryReservationMiB is required.
memoryReservationMiBoptionalnumbermemory_reservation_mi_boptionalint | floatmemoryReservationMiBoptionalNumberMemoryReservationMiBoptionaldoubleMemoryReservationMiBoptional*float64#Default: No memory reserved.
notes
When system memory is under contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first.
At least one of memoryLimitMiB and memoryReservationMiB is required.
minHealthyPercentoptionalnumbermin_healthy_percentoptionalint | floatminHealthyPercentoptionalNumberMinHealthyPercentoptionaldoubleMinHealthyPercentoptional*float64#Default: 0 if daemon, otherwise 50
openListeneroptionalbooleanopen_listeneroptionalboolopenListeneroptionalBooleanOpenListeneroptionalboolOpenListeneroptional*bool#Default: true -- The security group allows ingress from all IP addresses.
placementConstraintsoptionalPlacementConstraint[]placement_constraintsoptionaltyping.List[PlacementConstraint]placementConstraintsoptionalList<PlacementConstraint>PlacementConstraintsoptionalPlacementConstraint[]PlacementConstraintsoptional*[]PlacementConstraint#Default: No constraints.
For more information, see Amazon ECS Task Placement Constraints.
placementStrategiesoptionalPlacementStrategy[]placement_strategiesoptionaltyping.List[PlacementStrategy]placementStrategiesoptionalList<PlacementStrategy>PlacementStrategiesoptionalPlacementStrategy[]PlacementStrategiesoptional*[]PlacementStrategy#Default: No strategies.
For more information, see Amazon ECS Task Placement Strategies.
propagateTagsoptionalPropagatedTagSourcepropagate_tagsoptionalPropagatedTagSourcepropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSource= none#Tags can only be propagated to the tasks within the service during service creation.
protocoloptionalApplicationProtocolprotocoloptionalApplicationProtocolprotocoloptionalApplicationProtocolProtocoloptionalApplicationProtocolProtocoloptionalApplicationProtocol#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.
protocolVersionoptionalApplicationProtocolVersionprotocol_versionoptionalApplicationProtocolVersionprotocolVersionoptionalApplicationProtocolVersionProtocolVersionoptionalApplicationProtocolVersionProtocolVersionoptionalApplicationProtocolVersion= ApplicationProtocolVersion.HTTP1#publicLoadBalanceroptionalbooleanpublic_load_balanceroptionalboolpublicLoadBalanceroptionalBooleanPublicLoadBalanceroptionalboolPublicLoadBalanceroptional*bool= true#recordTypeoptionalApplicationLoadBalancedServiceRecordTyperecord_typeoptionalApplicationLoadBalancedServiceRecordTyperecordTypeoptionalApplicationLoadBalancedServiceRecordTypeRecordTypeoptionalApplicationLoadBalancedServiceRecordTypeRecordTypeoptionalApplicationLoadBalancedServiceRecordType#Default: ApplicationLoadBalancedServiceRecordType.ALIAS
This is useful if you need to work with DNS systems that do not support alias records.
redirectHTTPoptionalbooleanredirect_httpoptionalboolredirectHTTPoptionalBooleanRedirectHTTPoptionalboolRedirectHTTPoptional*bool= false#This is only valid if the protocol of the ALB is HTTPS.
serviceNameoptionalstringservice_nameoptionalstrserviceNameoptionalStringServiceNameoptionalstringServiceNameoptional*string#Default: CloudFormation-generated name.
sslPolicyoptionalSslPolicyssl_policyoptionalSslPolicysslPolicyoptionalSslPolicySslPolicyoptionalSslPolicySslPolicyoptionalSslPolicy#Default: The recommended elastic load balancing security policy
targetProtocoloptionalApplicationProtocoltarget_protocoloptionalApplicationProtocoltargetProtocoloptionalApplicationProtocolTargetProtocoloptionalApplicationProtocolTargetProtocoloptionalApplicationProtocol= HTTP.#The default target port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS).
taskDefinitionoptionalEc2TaskDefinitiontask_definitionoptionalEc2TaskDefinitiontaskDefinitionoptionalEc2TaskDefinitionTaskDefinitionoptionalEc2TaskDefinitionTaskDefinitionoptionalEc2TaskDefinition= none#[disable-awslint:ref-via-interface]
taskImageOptionsoptionalApplicationLoadBalancedTaskImageOptionstask_image_optionsoptionalApplicationLoadBalancedTaskImageOptionstaskImageOptionsoptionalApplicationLoadBalancedTaskImageOptionsTaskImageOptionsoptionalApplicationLoadBalancedTaskImageOptionsTaskImageOptionsoptionalApplicationLoadBalancedTaskImageOptions= none#TaskDefinition or TaskImageOptions must be specified, but not both.
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.
Properties
certificatemay be undefinedICertificatecertificatemay be undefinedICertificatecertificatemay be undefinedICertificateCertificatemay be undefinedICertificateCertificatemay be undefinedICertificate#internalDesiredCountmay be undefinednumberinternal_desired_countmay be undefinedint | floatinternalDesiredCountmay be undefinedNumberInternalDesiredCountmay be undefineddoubleInternalDesiredCountmay be undefined*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#redirectListenermay be undefinedApplicationListenerredirect_listenermay be undefinedApplicationListenerredirectListenermay be undefinedApplicationListenerRedirectListenermay be undefinedApplicationListenerRedirectListenermay be undefinedApplicationListener#targetGroupApplicationTargetGrouptarget_groupApplicationTargetGrouptargetGroupApplicationTargetGroupTargetGroupApplicationTargetGroupTargetGroupApplicationTargetGrouprequired#taskDefinitionEc2TaskDefinitiontask_definitionEc2TaskDefinitiontaskDefinitionEc2TaskDefinitionTaskDefinitionEc2TaskDefinitionTaskDefinitionEc2TaskDefinitionrequired#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