ApplicationLoadBalancedFargateService

class aws_cdk.aws_ecs_patterns.ApplicationLoadBalancedFargateService(scope, id, *, assign_public_ip=None, health_check=None, security_groups=None, task_subnets=None, capacity_provider_strategies=None, certificate=None, circuit_breaker=None, cloud_map_options=None, cluster=None, deployment_controller=None, desired_count=None, domain_name=None, domain_zone=None, enable_ecs_managed_tags=None, enable_execute_command=None, health_check_grace_period=None, idle_timeout=None, listener_port=None, load_balancer=None, load_balancer_name=None, max_healthy_percent=None, min_healthy_percent=None, open_listener=None, propagate_tags=None, protocol=None, protocol_version=None, public_load_balancer=None, record_type=None, redirect_http=None, service_name=None, ssl_policy=None, target_protocol=None, task_image_options=None, vpc=None, cpu=None, ephemeral_storage_gib=None, memory_limit_mib=None, platform_version=None, runtime_platform=None, task_definition=None)

Bases: ApplicationLoadBalancedServiceBase

A Fargate service running on an ECS cluster fronted by an application load balancer.

ExampleMetadata:: infused

Example:

# 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")
    ),
    task_subnets=ec2.SubnetSelection(
        subnets=[ec2.Subnet.from_subnet_id(self, "subnet", "VpcISOLATEDSubnet1Subnet80F07FA0")]
    ),
    load_balancer_name="application-lb-name"
)

Constructs a new instance of the ApplicationLoadBalancedFargateService class.

Parameters:

scope (Construct) –
id (str) –
assign_public_ip (Optional[bool]) – Determines whether the service will be assigned a public IP address. Default: false
health_check (Union[HealthCheck, Dict[str, Any], None]) – The health check command and associated configuration parameters for the container. Default: - Health check configuration from container.
security_groups (Optional[Sequence[ISecurityGroup]]) – The security groups to associate with the service. If you do not specify a security group, a new security group is created. Default: - A new security group is created.
task_subnets (Union[SubnetSelection, Dict[str, Any], None]) – The subnets to associate with the service. Default: - Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.
capacity_provider_strategies (Optional[Sequence[Union[CapacityProviderStrategy, Dict[str, Any]]]]) – A list of Capacity Provider strategies used to place a service. Default: - undefined
certificate (Optional[ICertificate]) – Certificate Manager certificate to associate with the load balancer. Setting this option will set the load balancer protocol to HTTPS. 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.
circuit_breaker (Union[DeploymentCircuitBreaker, Dict[str, Any], None]) – Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled. Default: - disabled
cloud_map_options (Union[CloudMapOptions, Dict[str, Any], None]) – The options for configuring an Amazon ECS service to use service discovery. Default: - AWS Cloud Map service discovery is not enabled.
cluster (Optional[ICluster]) – 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. Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
deployment_controller (Union[DeploymentController, Dict[str, Any], None]) – Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types Default: - Rolling update (ECS)
desired_count (Union[int, float, None]) – The desired number of instantiations of the task definition to keep running on the service. The minimum value is 1 Default: - The default is 1 for all new services and uses the existing service’s desired count when updating an existing service.
domain_name (Optional[str]) – The domain name for the service, e.g. “api.example.com.”. Default: - No domain name.
domain_zone (Optional[IHostedZone]) – The Route53 hosted zone for the domain, e.g. “example.com.”. Default: - No Route53 hosted domain zone.
enable_ecs_managed_tags (Optional[bool]) – Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources Default: false
enable_execute_command (Optional[bool]) – Whether ECS Exec should be enabled. Default: - false
health_check_grace_period (Optional[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. Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
idle_timeout (Optional[Duration]) – The load balancer idle timeout, in seconds. Can be between 1 and 4000 seconds Default: - CloudFormation sets idle timeout to 60 seconds
listener_port (Union[int, float, None]) – Listener port of the application load balancer that will serve traffic to the service. 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.
load_balancer (Optional[IApplicationLoadBalancer]) – 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] Default: - a new load balancer will be created.
load_balancer_name (Optional[str]) – Name of the load balancer. Default: - Automatically generated name.
max_healthy_percent (Union[int, float, None]) – 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. Default: - 100 if daemon, otherwise 200
min_healthy_percent (Union[int, float, None]) – 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. Default: - 0 if daemon, otherwise 50
open_listener (Optional[bool]) – Determines whether or not the Security Group for the Load Balancer’s Listener will be open to all traffic by default. Default: true – The security group allows ingress from all IP addresses.
propagate_tags (Optional[PropagatedTagSource]) – 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. Default: - none
protocol (Optional[ApplicationProtocol]) – 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. Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.
protocol_version (Optional[ApplicationProtocolVersion]) – The protocol version to use. Default: ApplicationProtocolVersion.HTTP1
public_load_balancer (Optional[bool]) – Determines whether the Load Balancer will be internet-facing. Default: true
record_type (Optional[ApplicationLoadBalancedServiceRecordType]) – 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. Default: ApplicationLoadBalancedServiceRecordType.ALIAS
redirect_http (Optional[bool]) – 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. Default: false
service_name (Optional[str]) – The name of the service. Default: - CloudFormation-generated name.
ssl_policy (Optional[SslPolicy]) – The security policy that defines which ciphers and protocols are supported by the ALB Listener. Default: - The recommended elastic load balancing security policy
target_protocol (Optional[ApplicationProtocol]) – 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). Default: HTTP.
task_image_options (Union[ApplicationLoadBalancedTaskImageOptions, Dict[str, Any], None]) – The properties required to create a new task definition. TaskDefinition or TaskImageOptions must be specified, but not both. Default: none
vpc (Optional[IVpc]) – 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. Default: - uses the VPC defined in the cluster or creates a new VPC.
cpu (Union[int, float, None]) – 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. Default: 256
ephemeral_storage_gib (Union[int, float, None]) – 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. Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.
memory_limit_mib (Union[int, float, None]) – 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. Default: 512
platform_version (Optional[FargatePlatformVersion]) – 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. Default: Latest
runtime_platform (Union[RuntimePlatform, Dict[str, Any], None]) – The runtime platform of the task definition. Default: - If the property is undefined, operatingSystemFamily is LINUX and cpuArchitecture is X86_64
task_definition (Optional[FargateTaskDefinition]) – The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. [disable-awslint:ref-via-interface] Default: - none

Methods

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

assign_public_ip: Determines whether the service will be assigned a public IP address.

certificate: Certificate Manager certificate to associate with the load balancer.

cluster: The cluster that hosts the service.

internal_desired_count

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.

listener: The listener for the service.

load_balancer: The Application Load Balancer for the service.

node: The tree node.

redirect_listener: The redirect listener for the service if redirectHTTP is enabled.

service: The Fargate service in this construct.

target_group: The target group for the service.

task_definition: The Fargate task definition in this construct.

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

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:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.