ApplicationMultipleTargetGroupsEc2Service L3 construct
An EC2 service running on an ECS cluster fronted by an application load balancer.
Example
// One application load balancer with one listener and two target groups.
declare const cluster: ecs.Cluster;
const loadBalancedEc2Service = new ecsPatterns.ApplicationMultipleTargetGroupsEc2Service(this, 'Service', {
cluster,
memoryLimitMiB: 256,
taskImageOptions: {
image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
},
targetGroups: [
{
containerPort: 80,
},
{
containerPort: 90,
pathPattern: 'a/b/c',
priority: 10,
},
],
});
# One application load balancer with one listener and two target groups.
# cluster: ecs.Cluster
load_balanced_ec2_service = ecs_patterns.ApplicationMultipleTargetGroupsEc2Service(self, "Service",
cluster=cluster,
memory_limit_mi_b=256,
task_image_options=ecsPatterns.ApplicationLoadBalancedTaskImageProps(
image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample")
),
target_groups=[ecsPatterns.ApplicationTargetProps(
container_port=80
), ecsPatterns.ApplicationTargetProps(
container_port=90,
path_pattern="a/b/c",
priority=10
)
]
)
// One application load balancer with one listener and two target groups.
Cluster cluster;
ApplicationMultipleTargetGroupsEc2Service loadBalancedEc2Service = ApplicationMultipleTargetGroupsEc2Service.Builder.create(this, "Service")
.cluster(cluster)
.memoryLimitMiB(256)
.taskImageOptions(ApplicationLoadBalancedTaskImageProps.builder()
.image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
.build())
.targetGroups(List.of(ApplicationTargetProps.builder()
.containerPort(80)
.build(), ApplicationTargetProps.builder()
.containerPort(90)
.pathPattern("a/b/c")
.priority(10)
.build()))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// One application load balancer with one listener and two target groups.
Cluster cluster;
var loadBalancedEc2Service = new ApplicationMultipleTargetGroupsEc2Service(this, "Service", new ApplicationMultipleTargetGroupsEc2ServiceProps {
Cluster = cluster,
MemoryLimitMiB = 256,
TaskImageOptions = new ApplicationLoadBalancedTaskImageProps {
Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample")
},
TargetGroups = new [] { new ApplicationTargetProps {
ContainerPort = 80
}, new ApplicationTargetProps {
ContainerPort = 90,
PathPattern = "a/b/c",
Priority = 10
} }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// One application load balancer with one listener and two target groups.
var cluster Cluster
loadBalancedEc2Service := ecsPatterns.NewApplicationMultipleTargetGroupsEc2Service(this, jsii.String("Service"), &ApplicationMultipleTargetGroupsEc2ServiceProps{
Cluster: Cluster,
MemoryLimitMiB: jsii.Number(256),
TaskImageOptions: &ApplicationLoadBalancedTaskImageProps{
Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")),
},
TargetGroups: []ApplicationTargetProps{
&ApplicationTargetProps{
ContainerPort: jsii.Number(80),
},
&ApplicationTargetProps{
ContainerPort: jsii.Number(90),
PathPattern: jsii.String("a/b/c"),
Priority: jsii.Number(10),
},
},
})
Initializer
new ApplicationMultipleTargetGroupsEc2Service(scope: Construct, id: string, props?: ApplicationMultipleTargetGroupsEc2ServiceProps)
ApplicationMultipleTargetGroupsEc2Service(scope: Construct, id: str, props: typing.Optional[ApplicationMultipleTargetGroupsEc2ServiceProps] = None)
new ApplicationMultipleTargetGroupsEc2Service(Construct scope, String id, ApplicationMultipleTargetGroupsEc2ServiceProps props)
new ApplicationMultipleTargetGroupsEc2Service(Construct scope, string id, ApplicationMultipleTargetGroupsEc2ServiceProps? props = null)
NewApplicationMultipleTargetGroupsEc2Service(Scope Construct, Id *string, Props ApplicationMultipleTargetGroupsEc2ServiceProps)
Construct Props
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.
Default: No minimum CPU units reserved.
Valid values, which determines your range of valid values for the memory parameter:
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.
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
loadBalancersoptionalApplicationLoadBalancerProps[]load_balancersoptionaltyping.List[ApplicationLoadBalancerProps]loadBalancersoptionalList<ApplicationLoadBalancerProps>LoadBalancersoptionalApplicationLoadBalancerProps[]LoadBalancersoptional*[]ApplicationLoadBalancerProps#Default: a new load balancer with a listener will be created.
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 heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.
At least one of memoryLimitMiB and memoryReservationMiB is required.
Note that this setting will be ignored if TaskImagesOptions is specified
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.
serviceNameoptionalstringservice_nameoptionalstrserviceNameoptionalStringServiceNameoptionalstringServiceNameoptional*string#Default: CloudFormation-generated name.
targetGroupsoptionalApplicationTargetProps[]target_groupsoptionaltyping.List[ApplicationTargetProps]targetGroupsoptionalList<ApplicationTargetProps>TargetGroupsoptionalApplicationTargetProps[]TargetGroupsoptional*[]ApplicationTargetProps#Default: default portMapping registered as target group and attached to the first defined listener
taskDefinitionoptionalEc2TaskDefinitiontask_definitionoptionalEc2TaskDefinitiontaskDefinitionoptionalEc2TaskDefinitionTaskDefinitionoptionalEc2TaskDefinitionTaskDefinitionoptionalEc2TaskDefinition= none#[disable-awslint:ref-via-interface]
taskImageOptionsoptionalApplicationLoadBalancedTaskImagePropstask_image_optionsoptionalApplicationLoadBalancedTaskImagePropstaskImageOptionsoptionalApplicationLoadBalancedTaskImagePropsTaskImageOptionsoptionalApplicationLoadBalancedTaskImagePropsTaskImageOptionsoptionalApplicationLoadBalancedTaskImageProps= none#Only one of TaskDefinition or TaskImageOptions must be specified.
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
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.
listenerApplicationListenerlistenerApplicationListenerlistenerApplicationListenerListenerApplicationListenerListenerApplicationListenerrequireddeprecated#listenersApplicationListener[]listenerstyping.List[ApplicationListener]listenersList<ApplicationListener>ListenersApplicationListener[]Listeners*[]ApplicationListenerrequired#loadBalancerApplicationLoadBalancerload_balancerApplicationLoadBalancerloadBalancerApplicationLoadBalancerLoadBalancerApplicationLoadBalancerLoadBalancerApplicationLoadBalancerrequireddeprecated#loadBalancersApplicationLoadBalancer[]load_balancerstyping.List[ApplicationLoadBalancer]loadBalancersList<ApplicationLoadBalancer>LoadBalancersApplicationLoadBalancer[]LoadBalancers*[]ApplicationLoadBalancerrequired#targetGroupApplicationTargetGrouptarget_groupApplicationTargetGrouptargetGroupApplicationTargetGroupTargetGroupApplicationTargetGroupTargetGroupApplicationTargetGrouprequireddeprecated#targetGroupsApplicationTargetGroup[]target_groupstyping.List[ApplicationTargetGroup]targetGroupsList<ApplicationTargetGroup>TargetGroupsApplicationTargetGroup[]TargetGroups*[]ApplicationTargetGrouprequired#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