IApplicationListener

class aws_cdk.aws_elasticloadbalancingv2.IApplicationListener(*args, **kwargs)

Bases: aws_cdk.core.IResource, aws_cdk.aws_ec2.IConnectable, typing_extensions.Protocol

Properties to reference an existing listener.

__init__(*args, **kwargs)

Methods

add_certificate_arns(id, arns)

Add one or more certificates to this listener.

Parameters
  • id (str) –

  • arns (List[str]) –

Return type

None

add_target_groups(id, *, target_groups, host_header=None, path_pattern=None, priority=None)

Load balance incoming requests to the given target groups.

It’s possible to add conditions to the TargetGroups added in this way. At least one TargetGroup must be added without conditions.

Parameters
  • id (str) –

  • props

  • target_groups (List[IApplicationTargetGroup]) – Target groups to forward requests to.

  • host_header (Optional[str]) – Rule applies if the requested host matches the indicated host. May contain up to three ‘*’ wildcards. Requires that priority is set. Default: No host condition

  • path_pattern (Optional[str]) – Rule applies if the requested path matches the given path pattern. May contain up to three ‘*’ wildcards. Requires that priority is set. Default: No path condition

  • priority (Union[int, float, None]) – Priority of this target group. The rule with the lowest priority will be used for every request. If priority is not given, these target groups will be added as defaults, and must not have conditions. Priorities must be unique. Default: Target groups are used as defaults

Return type

None

add_targets(id, *, deregistration_delay=None, health_check=None, port=None, protocol=None, slow_start=None, stickiness_cookie_duration=None, target_group_name=None, targets=None, host_header=None, path_pattern=None, priority=None)

Load balance incoming requests to the given load balancing targets.

This method implicitly creates an ApplicationTargetGroup for the targets involved.

It’s possible to add conditions to the targets added in this way. At least one set of targets must be added without conditions.

Parameters
  • id (str) –

  • props

  • deregistration_delay (Optional[Duration]) – The amount of time for Elastic Load Balancing to wait before deregistering a target. The range is 0-3600 seconds. Default: Duration.minutes(5)

  • health_check (Optional[HealthCheck]) – Health check configuration. Default: No health check

  • port (Union[int, float, None]) – The port on which the listener listens for requests. Default: Determined from protocol if known

  • protocol (Optional[ApplicationProtocol]) – The protocol to use. Default: Determined from port if known

  • slow_start (Optional[Duration]) – The time period during which the load balancer sends a newly registered target a linearly increasing share of the traffic to the target group. The range is 30-900 seconds (15 minutes). Default: 0

  • stickiness_cookie_duration (Optional[Duration]) – The stickiness cookie expiration period. Setting this value enables load balancer stickiness. After this period, the cookie is considered stale. The minimum value is 1 second and the maximum value is 7 days (604800 seconds). Default: Duration.days(1)

  • target_group_name (Optional[str]) – The name of the target group. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. Default: Automatically generated

  • targets (Optional[List[IApplicationLoadBalancerTarget]]) – The targets to add to this target group. Can be Instance, IPAddress, or any self-registering load balancing target. All target must be of the same type.

  • host_header (Optional[str]) – Rule applies if the requested host matches the indicated host. May contain up to three ‘*’ wildcards. Requires that priority is set. Default: No host condition

  • path_pattern (Optional[str]) – Rule applies if the requested path matches the given path pattern. May contain up to three ‘*’ wildcards. Requires that priority is set. Default: No path condition

  • priority (Union[int, float, None]) – Priority of this target group. The rule with the lowest priority will be used for every request. If priority is not given, these target groups will be added as defaults, and must not have conditions. Priorities must be unique. Default: Target groups are used as defaults

return :rtype: ApplicationTargetGroup :return: The newly created target group

register_connectable(connectable, port_range)

Register that a connectable that has been added to this load balancer.

Don’t call this directly. It is called by ApplicationTargetGroup.

Parameters
Return type

None

Attributes

connections
Return type

Connections

listener_arn

ARN of the listener.

attribute: :attribute:: true

Return type

str

node

The construct node in the tree.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack