ApplicationLoadBalancedFargateServiceProps¶

class aws_cdk.aws_ecs_patterns.ApplicationLoadBalancedFargateServiceProps(*, 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, 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, record_type=None, redirect_http=None, service_name=None, target_protocol=None, task_image_options=None, vpc=None, assign_public_ip=None, cpu=None, memory_limit_mib=None, platform_version=None, security_groups=None, task_definition=None, task_subnets=None)¶

Bases: aws_cdk.aws_ecs_patterns.ApplicationLoadBalancedServiceBaseProps

The properties for the ApplicationLoadBalancedFargateService service.

Parameters

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.
circuit_breaker (Optional[DeploymentCircuitBreaker]) – Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled. Default: - disabled
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.
deployment_controller (Optional[DeploymentController]) – 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: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the default is 1 for all new services and uses the existing services 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
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
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.
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 (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.
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
security_groups (Optional[Sequence[ISecurityGroup]]) – The security groups to associate with the service. If you do not specify a security group, the default security group for the VPC is used. Default: - A new security group is created.
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
task_subnets (Optional[SubnetSelection]) – 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.

Attributes

assign_public_ip¶

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

Default: false
Return type: Optional[bool]

certificate¶

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.

Return type: Optional[ICertificate]

circuit_breaker¶

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

Default

disabled

Return type

Optional[DeploymentCircuitBreaker]

cloud_map_options¶

The options for configuring an Amazon ECS service to use service discovery.

Default

AWS Cloud Map service discovery is not enabled.

Return type

Optional[CloudMapOptions]

cluster¶

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.

Return type

Optional[ICluster]

cpu¶

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
Return type: Union[int, float, None]

deployment_controller¶

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default

Rolling update (ECS)

Return type

Optional[DeploymentController]

desired_count¶

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

The minimum value is 1

Default

If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1;

if true, the default is 1 for all new services and uses the existing services desired count when updating an existing service.

Return type: Union[int, float, None]

domain_name¶

The domain name for the service, e.g. “api.example.com.”.

Default

No domain name.

Return type

Optional[str]

domain_zone¶

The Route53 hosted zone for the domain, e.g. “example.com.”.

Default

No Route53 hosted domain zone.

Return type

Optional[IHostedZone]

enable_ecs_managed_tags¶

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
Return type: Optional[bool]

health_check_grace_period¶

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

Return type

Optional[Duration]

listener_port¶

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.

Return type: Union[int, float, None]

load_balancer¶

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.

Return type

Optional[IApplicationLoadBalancer]

max_healthy_percent¶

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

Return type

Union[int, float, None]

memory_limit_mib¶

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
Return type: Union[int, float, None]

min_healthy_percent¶

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

Return type

Union[int, float, None]

open_listener¶

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.
Return type: Optional[bool]

platform_version¶

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
Return type: Optional[FargatePlatformVersion]

propagate_tags¶

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

Return type

Optional[PropagatedTagSource]

protocol¶

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.

Return type: Optional[ApplicationProtocol]

public_load_balancer¶

Determines whether the Load Balancer will be internet-facing.

Default: true
Return type: Optional[bool]

record_type¶

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
Return type: Optional[ApplicationLoadBalancedServiceRecordType]

redirect_http¶

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
Return type: Optional[bool]

security_groups¶

The security groups to associate with the service.

If you do not specify a security group, the default security group for the VPC is used.

Default

A new security group is created.

Return type

Optional[List[ISecurityGroup]]

service_name¶

The name of the service.

Default

CloudFormation-generated name.

Return type

Optional[str]

target_protocol¶

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.
Return type: Optional[ApplicationProtocol]

task_definition¶

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

Return type

Optional[FargateTaskDefinition]

task_image_options¶

The properties required to create a new task definition.

TaskDefinition or TaskImageOptions must be specified, but not both.

Default: none
Return type: Optional[ApplicationLoadBalancedTaskImageOptions]

task_subnets¶

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.

Return type

Optional[SubnetSelection]

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.

Default

uses the VPC defined in the cluster or creates a new VPC.

Return type

Optional[IVpc]