ApplicationLoadBalancedFargateService

class aws_cdk.aws_ecs_patterns.ApplicationLoadBalancedFargateService(scope, id, *, assign_public_ip=None, cpu=None, memory_limit_mib=None, platform_version=None, task_definition=None, certificate=None, cloud_map_options=None, cluster=None, desired_count=None, domain_name=None, domain_zone=None, enable_ecs_managed_tags=None, health_check_grace_period=None, listener_port=None, load_balancer=None, max_healthy_percent=None, min_healthy_percent=None, open_listener=None, propagate_tags=None, protocol=None, public_load_balancer=None, redirect_http=None, service_name=None, task_image_options=None, vpc=None)

Bases: aws_cdk.aws_ecs_patterns.ApplicationLoadBalancedServiceBase

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

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

  • 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 This default is set in the underlying FargateTaskDefinition construct. Default: 256

  • 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) 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

  • 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

  • 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.

  • cloud_map_options (Optional[CloudMapOptions]) – 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.

  • 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: 1

  • 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

  • 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

  • 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.

  • 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). A domain name and zone must be also be specified if using HTTPS. Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.

  • public_load_balancer (Optional[bool]) – Determines whether the Load Balancer will be internet-facing. Default: true

  • 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.

  • task_image_options (Optional[ApplicationLoadBalancedTaskImageOptions]) – 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.

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.

Return type

bool

certificate

Certificate Manager certificate to associate with the load balancer.

Return type

Optional[ICertificate]

cluster

The cluster that hosts the service.

Return type

ICluster

desired_count

The desired number of instantiations of the task definition to keep running on the service.

Return type

Union[int, float]

listener

The listener for the service.

Return type

ApplicationListener

load_balancer

The Application Load Balancer for the service.

Return type

ApplicationLoadBalancer

node

The construct tree node associated with this construct.

Return type

ConstructNode

redirect_listener

The redirect listener for the service if redirectHTTP is enabled.

Return type

Optional[ApplicationListener]

service

The Fargate service in this construct.

Return type

FargateService

target_group

The target group for the service.

Return type

ApplicationTargetGroup

task_definition

The Fargate task definition in this construct.

Return type

FargateTaskDefinition

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool