ApplicationListenerProps

class aws_cdk.aws_ecs_patterns.ApplicationListenerProps(*, name, certificate=None, port=None, protocol=None)

Bases: object

Properties to define an application listener.

Parameters

  • name (str) – Name of the listener.

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

  • 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 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: ApplicationProtocol.HTTP. If a certificate is specified, the protocol will be set by default to ApplicationProtocol.HTTPS.

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]

name

Name of the listener.

Return type

str

port

The port on which the listener listens for requests.

Default

  • Determined from protocol if known.

Return type

Union[int, float, None]

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

ApplicationProtocol.HTTP. If a certificate is specified, the protocol will be set by default to ApplicationProtocol.HTTPS.

Return type

Optional[ApplicationProtocol]