ApplicationMultipleTargetGroupsEc2Service

class aws_cdk.aws_ecs_patterns.ApplicationMultipleTargetGroupsEc2Service(scope, id, *, cpu=None, memory_limit_mib=None, memory_reservation_mib=None, placement_constraints=None, placement_strategies=None, task_definition=None, cloud_map_options=None, cluster=None, desired_count=None, enable_ecs_managed_tags=None, enable_execute_command=None, health_check_grace_period=None, load_balancers=None, propagate_tags=None, service_name=None, target_groups=None, task_image_options=None, vpc=None)

Bases: ApplicationMultipleTargetGroupsServiceBase

An EC2 service running on an ECS cluster fronted by an application load balancer.

ExampleMetadata:: infused

Example:

# One application load balancer with one listener and two target groups.
# cluster: ecs.Cluster

load_balanced_ec2_service = ecs_patterns.ApplicationMultipleTargetGroupsEc2Service(self, "Service",
    cluster=cluster,
    memory_limit_mi_b=256,
    task_image_options=ecsPatterns.ApplicationLoadBalancedTaskImageProps(
        image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample")
    ),
    target_groups=[ecsPatterns.ApplicationTargetProps(
        container_port=80
    ), ecsPatterns.ApplicationTargetProps(
        container_port=90,
        path_pattern="a/b/c",
        priority=10
    )
    ]
)

Constructs a new instance of the ApplicationMultipleTargetGroupsEc2Service class.

Parameters:

scope (Construct) –
id (str) –
cpu (Union[int, float, None]) – The minimum number of CPU units to reserve for the container. Valid values, which determines your range of valid values for the memory parameter: Default: - No minimum CPU units reserved.
memory_limit_mib (Union[int, float, None]) – The amount (in MiB) of memory to present to the container. If your container attempts to exceed the allocated memory, the container is terminated. At least one of memoryLimitMiB and memoryReservationMiB is required. Default: - No memory limit.
memory_reservation_mib (Union[int, float, None]) – The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. At least one of memoryLimitMiB and memoryReservationMiB is required. Note that this setting will be ignored if TaskImagesOptions is specified Default: - No memory reserved.
placement_constraints (Optional[Sequence[PlacementConstraint]]) – The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints. Default: - No constraints.
placement_strategies (Optional[Sequence[PlacementStrategy]]) – The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies. Default: - No strategies.
task_definition (Optional[Ec2TaskDefinition]) – The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified. [disable-awslint:ref-via-interface] Default: - none
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.
desired_count (Union[int, float, None]) – The desired number of instantiations of the task definition to keep running on the service. Default: - The default is 1 for all new services and uses the existing service’s desired count when updating an existing service.
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
load_balancers (Optional[Sequence[Union[ApplicationLoadBalancerProps, Dict[str, Any]]]]) – The application load balancer that will serve traffic to the service. Default: - a new load balancer with a listener will be created.
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
service_name (Optional[str]) – The name of the service. Default: - CloudFormation-generated name.
target_groups (Optional[Sequence[Union[ApplicationTargetProps, Dict[str, Any]]]]) – Properties to specify ALB target groups. Default: - default portMapping registered as target group and attached to the first defined listener
task_image_options (Union[ApplicationLoadBalancedTaskImageProps, Dict[str, Any], None]) – The properties required to create a new task definition. Only one of TaskDefinition or TaskImageOptions must be specified. 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

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

(deprecated) The default listener for the service (first added listener).

Deprecated:

Use listeners instead.

Stability:

deprecated

listeners: The listeners of the service.

load_balancer

(deprecated) The default Application Load Balancer for the service (first added load balancer).

Deprecated:

Use loadBalancers instead.

Stability:

deprecated

load_balancers: The load balancers of the service.

node: The tree node.

service: The EC2 service in this construct.

target_group

(deprecated) The default target group for the service.

Deprecated:

Use targetGroups instead.

Stability:

deprecated

target_groups: The target groups of the service.

task_definition: The EC2 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.