ApplicationLoadBalancedServiceBaseProps¶

class aws_cdk.aws_ecs_patterns.ApplicationLoadBalancedServiceBaseProps(*, 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: object

The properties for the base ApplicationLoadBalancedEc2Service or 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.
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 (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.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_certificatemanager as certificatemanager
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_ecs as ecs
import aws_cdk.aws_ecs_patterns as ecs_patterns
import aws_cdk.aws_elasticloadbalancingv2 as elbv2
import aws_cdk.aws_iam as iam
import aws_cdk.aws_route53 as route53
import aws_cdk.aws_servicediscovery as servicediscovery
import aws_cdk.core as cdk

# application_load_balancer: elbv2.ApplicationLoadBalancer
# certificate: certificatemanager.Certificate
# cluster: ecs.Cluster
# container_definition: ecs.ContainerDefinition
# container_image: ecs.ContainerImage
# hosted_zone: route53.HostedZone
# log_driver: ecs.LogDriver
# namespace: servicediscovery.INamespace
# role: iam.Role
# secret: ecs.Secret
# vpc: ec2.Vpc

application_load_balanced_service_base_props = ecs_patterns.ApplicationLoadBalancedServiceBaseProps(
    certificate=certificate,
    circuit_breaker=ecs.DeploymentCircuitBreaker(
        rollback=False
    ),
    cloud_map_options=ecs.CloudMapOptions(
        cloud_map_namespace=namespace,
        container=container_definition,
        container_port=123,
        dns_record_type=servicediscovery.DnsRecordType.A,
        dns_ttl=cdk.Duration.minutes(30),
        failure_threshold=123,
        name="name"
    ),
    cluster=cluster,
    deployment_controller=ecs.DeploymentController(
        type=ecs.DeploymentControllerType.ECS
    ),
    desired_count=123,
    domain_name="domainName",
    domain_zone=hosted_zone,
    enable_eCSManaged_tags=False,
    health_check_grace_period=cdk.Duration.minutes(30),
    listener_port=123,
    load_balancer=application_load_balancer,
    load_balancer_name="loadBalancerName",
    max_healthy_percent=123,
    min_healthy_percent=123,
    open_listener=False,
    propagate_tags=ecs.PropagatedTagSource.SERVICE,
    protocol=elbv2.ApplicationProtocol.HTTP,
    protocol_version=elbv2.ApplicationProtocolVersion.GRPC,
    public_load_balancer=False,
    record_type=ecs_patterns.ApplicationLoadBalancedServiceRecordType.ALIAS,
    redirect_hTTP=False,
    service_name="serviceName",
    ssl_policy=elbv2.SslPolicy.RECOMMENDED,
    target_protocol=elbv2.ApplicationProtocol.HTTP,
    task_image_options=ecs_patterns.ApplicationLoadBalancedTaskImageOptions(
        image=container_image,

        # the properties below are optional
        container_name="containerName",
        container_port=123,
        docker_labels={
            "docker_labels_key": "dockerLabels"
        },
        enable_logging=False,
        environment={
            "environment_key": "environment"
        },
        execution_role=role,
        family="family",
        log_driver=log_driver,
        secrets={
            "secrets_key": secret
        },
        task_role=role
    ),
    vpc=vpc
)

Attributes

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]

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]

load_balancer_name¶

Name of the load balancer.

Default

Automatically generated name.

Return type

Optional[str]

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]

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]

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]

protocol_version¶

The protocol version to use.

Default: ApplicationProtocolVersion.HTTP1
Return type: Optional[ApplicationProtocolVersion]

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]

service_name¶

The name of the service.

Default

CloudFormation-generated name.

Return type

Optional[str]

ssl_policy¶

The security policy that defines which ciphers and protocols are supported by the ALB Listener.

Default

The recommended elastic load balancing security policy

Return type

Optional[SslPolicy]

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_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]

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]