ListenerConfig

class aws_cdk.aws_ecs.ListenerConfig

Bases: object

Base class for configuring listener when registering targets.

__init__()

Initialize self. See help(type(self)) for accurate signature.

Return type

None

Methods

add_targets(id, target, service)

Create and attach a target group to listener.

Parameters
Return type

None

Static Methods

classmethod application_listener(listener, *, 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)

Create a config for adding target group to ALB listener.

Parameters
  • listener (ApplicationListener) –

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

ListenerConfig

classmethod network_listener(listener, *, port, deregistration_delay=None, health_check=None, proxy_protocol_v2=None, target_group_name=None, targets=None)

Create a config for adding target group to NLB listener.

Parameters
  • listener (NetworkListener) –

  • props

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

  • 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

  • proxy_protocol_v2 (Optional[bool]) – Indicates whether Proxy Protocol version 2 is enabled. Default: false

  • 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[INetworkLoadBalancerTarget]]) – The targets to add to this target group. Can be Instance, IPAddress, or any self-registering load balancing target. If you use either Instance or IPAddress as targets, all target must be of the same type.

Return type

ListenerConfig