class ApplicationMultipleTargetGroupsFargateService (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECS.Patterns.ApplicationMultipleTargetGroupsFargateService |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#ApplicationMultipleTargetGroupsFargateService |
![]() | software.amazon.awscdk.services.ecs.patterns.ApplicationMultipleTargetGroupsFargateService |
![]() | aws_cdk.aws_ecs_patterns.ApplicationMultipleTargetGroupsFargateService |
![]() | aws-cdk-lib » aws_ecs_patterns » ApplicationMultipleTargetGroupsFargateService |
Implements
IConstruct
, IDependable
A Fargate service running on an ECS cluster fronted by an application load balancer.
Example
import { Certificate } from 'aws-cdk-lib/aws-certificatemanager';
import { InstanceType } from 'aws-cdk-lib/aws-ec2';
import { Cluster, ContainerImage } from 'aws-cdk-lib/aws-ecs';
import { ApplicationProtocol, SslPolicy } from 'aws-cdk-lib/aws-elasticloadbalancingv2';
import { PublicHostedZone } from 'aws-cdk-lib/aws-route53';
const vpc = new ec2.Vpc(this, 'Vpc', { maxAzs: 1 });
const loadBalancedFargateService = new ecsPatterns.ApplicationMultipleTargetGroupsFargateService(this, 'myService', {
cluster: new ecs.Cluster(this, 'EcsCluster', { vpc }),
memoryLimitMiB: 256,
taskImageOptions: {
image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
},
enableExecuteCommand: true,
loadBalancers: [
{
name: 'lb',
idleTimeout: Duration.seconds(400),
domainName: 'api.example.com',
domainZone: new PublicHostedZone(this, 'HostedZone', { zoneName: 'example.com' }),
listeners: [
{
name: 'listener',
protocol: ApplicationProtocol.HTTPS,
certificate: Certificate.fromCertificateArn(this, 'Cert', 'helloworld'),
sslPolicy: SslPolicy.TLS12_EXT,
},
],
},
{
name: 'lb2',
idleTimeout: Duration.seconds(120),
domainName: 'frontend.com',
domainZone: new PublicHostedZone(this, 'HostedZone', { zoneName: 'frontend.com' }),
listeners: [
{
name: 'listener2',
protocol: ApplicationProtocol.HTTPS,
certificate: Certificate.fromCertificateArn(this, 'Cert2', 'helloworld'),
sslPolicy: SslPolicy.TLS12_EXT,
},
],
},
],
targetGroups: [
{
containerPort: 80,
listener: 'listener',
},
{
containerPort: 90,
pathPattern: 'a/b/c',
priority: 10,
listener: 'listener',
},
{
containerPort: 443,
listener: 'listener2',
},
{
containerPort: 80,
pathPattern: 'a/b/c',
priority: 10,
listener: 'listener2',
},
],
});
Initializer
new ApplicationMultipleTargetGroupsFargateService(scope: Construct, id: string, props?: ApplicationMultipleTargetGroupsFargateServiceProps)
Parameters
- scope
Construct
- id
string
- props
Application
Multiple Target Groups Fargate Service Props
Constructs a new instance of the ApplicationMultipleTargetGroupsFargateService class.
Construct Props
Name | Type | Description |
---|---|---|
assign | boolean | Determines whether the service will be assigned a public IP address. |
cloud | Cloud | 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. |
desired | number | The desired number of instantiations of the task definition to keep running on the service. |
enable | boolean | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
enable | boolean | Whether ECS Exec should be enabled. |
ephemeral | number | The amount (in GiB) of ephemeral storage to be allocated to the task. |
health | 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. |
load | Application [] | The application load balancer that will serve traffic to the service. |
memory | number | The amount (in MiB) of memory used by the task. |
platform | Fargate | The platform version on which to run your service. |
propagate | Propagated | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
runtime | Runtime | The runtime platform of the task definition. |
service | string | The name of the service. |
target | Application [] | Properties to specify ALB target groups. |
task | Fargate | The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. |
task | Application | The properties required to create a new task definition. |
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.
cloudMapOptions?
Type:
Cloud
(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.
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.
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.
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.
loadBalancers?
Type:
Application
[]
(optional, default: a new load balancer with a listener will be created.)
The application load balancer that will serve traffic to the service.
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.
platformVersion?
Type:
Fargate
(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:
Propagated
(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.
runtimePlatform?
Type:
Runtime
(optional, default: If the property is undefined, operatingSystemFamily
is LINUX and cpuArchitecture
is X86_64)
The runtime platform of the task definition.
serviceName?
Type:
string
(optional, default: CloudFormation-generated name.)
The name of the service.
targetGroups?
Type:
Application
[]
(optional, default: default portMapping registered as target group and attached to the first defined listener)
Properties to specify ALB target groups.
taskDefinition?
Type:
Fargate
(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:
Application
(optional, default: none)
The properties required to create a new task definition.
Only one of TaskDefinition or TaskImageOptions must be specified.
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.
Properties
Name | Type | Description |
---|---|---|
assign | boolean | Determines whether the service will be assigned a public IP address. |
cluster | ICluster | The cluster that hosts the service. |
listener | Application | The default listener for the service (first added listener). |
listeners | Application [] | The listeners of the service. |
load | Application | The default Application Load Balancer for the service (first added load balancer). |
load | Application [] | The load balancers of the service. |
node | Node | The tree node. |
service | Fargate | The Fargate service in this construct. |
target | Application | The default target group for the service. |
target | Application [] | The target groups of the service. |
task | Fargate | The Fargate task definition in this construct. |
internal | number | The desired number of instantiations of the task definition to keep running on the service. |
assignPublicIp
Type:
boolean
Determines whether the service will be assigned a public IP address.
cluster
Type:
ICluster
The cluster that hosts the service.
listener
⚠️ Deprecated: - Use listeners
instead.
Type:
Application
The default listener for the service (first added listener).
listeners
Type:
Application
[]
The listeners of the service.
loadBalancer
⚠️ Deprecated: - Use loadBalancers
instead.
Type:
Application
The default Application Load Balancer for the service (first added load balancer).
loadBalancers
Type:
Application
[]
The load balancers of the service.
node
Type:
Node
The tree node.
service
Type:
Fargate
The Fargate service in this construct.
targetGroup
⚠️ Deprecated: - Use targetGroups
instead.
Type:
Application
The default target group for the service.
targetGroups
Type:
Application
[]
The target groups of the service.
taskDefinition
Type:
Fargate
The Fargate task definition in this construct.
internalDesiredCount?
Type:
number
(optional)
The desired number of instantiations of the task definition to keep running on the service.
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.
Methods
Name | Description |
---|---|
to | Returns a string representation of this construct. |
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.