Interface IApplicationListener

Properties to reference an existing listener.

Inherited Members
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IApplicationListener : IConnectable, IApplicationListenerRef, IListener, IResource, IListenerRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Interface IApplicationListener Inherits IConnectable, IApplicationListenerRef, IListener, IResource, IListenerRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Methods

AddAction(string, IAddApplicationActionProps)

Perform the given action on incoming requests.
AddCertificates(string, IListenerCertificate[])

Add one or more certificates to this listener.
AddTargetGroups(string, IAddApplicationTargetGroupsProps)

Load balance incoming requests to the given target groups.
AddTargets(string, IAddApplicationTargetsProps)

Load balance incoming requests to the given load balancing targets.
RegisterConnectable(IConnectable, Port)

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

Methods

AddAction(string, IAddApplicationActionProps)

Perform the given action on incoming requests.

void AddAction(string id, IAddApplicationActionProps props)
Parameters
id string
props IAddApplicationActionProps
Remarks

This allows full control of the default action of the load balancer, including Action chaining, fixed responses and redirect responses. See the ListenerAction class for all options.

It's possible to add routing conditions to the Action added in this way.

It is not possible to add a default action to an imported IApplicationListener. In order to add actions to an imported IApplicationListener a priority must be provided.

AddCertificates(string, IListenerCertificate[])

Add one or more certificates to this listener.

void AddCertificates(string id, IListenerCertificate[] certificates)
Parameters
id string
certificates IListenerCertificate[]

AddTargetGroups(string, IAddApplicationTargetGroupsProps)

Load balance incoming requests to the given target groups.

void AddTargetGroups(string id, IAddApplicationTargetGroupsProps props)
Parameters
id string
props IAddApplicationTargetGroupsProps
Remarks

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

AddTargets(string, IAddApplicationTargetsProps)

Load balance incoming requests to the given load balancing targets.

ApplicationTargetGroup AddTargets(string id, IAddApplicationTargetsProps props)
Parameters
id string
props IAddApplicationTargetsProps
Returns

ApplicationTargetGroup

The newly created target group

Remarks

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.

RegisterConnectable(IConnectable, Port)

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

void RegisterConnectable(IConnectable connectable, Port portRange)
Parameters
connectable IConnectable
portRange Port
Remarks

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