ApplicationLoadBalancedServiceBase

class aws_cdk.aws_ecs_patterns.ApplicationLoadBalancedServiceBase(scope, id, *, 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, 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)

Bases: Construct

The base class for ApplicationLoadBalancedEc2Service and ApplicationLoadBalancedFargateService services.

Constructs a new instance of the ApplicationLoadBalancedServiceBase class.

Parameters:

  • scope (Construct)

  • id (str)

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

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

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

Methods

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

certificate

Certificate Manager certificate to associate with the load balancer.

cluster

The cluster that hosts the service.

desired_count

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

Deprecated:

  • Use internalDesiredCount instead.

Stability:

deprecated

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 construct tree node associated with this construct.

redirect_listener

The redirect listener for the service if redirectHTTP is enabled.

target_group

The target group for the service.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any)

Return type:

bool