Interface IApplicationListener

Properties to reference an existing listener.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Env

IResource.Stack

IConstruct.Node

IConnectable.Connections

Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2

Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll

Syntax (csharp)

public interface IApplicationListener : IResource, IConstruct, IDependable, IConnectable

Syntax (vb)

Public Interface IApplicationListener
    Inherits IResource, IConstruct, IConstruct, IDependable, IConnectable

Synopsis

Properties

ListenerArn

ARN of the listener.

Methods

AddAction(String, IAddApplicationActionProps)	Perform the given action on incoming requests.
AddCertificateArns(String, String[])	(deprecated) Add one or more certificates to this listener.
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.

Properties

ListenerArn

ARN of the listener.

string ListenerArn { get; }

Property Value

System.String

Remarks

Attribute: true

Methods

AddAction(String, IAddApplicationActionProps)

Perform the given action on incoming requests.

void AddAction(string id, IAddApplicationActionProps props)

Parameters

id System.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.

AddCertificateArns(String, String[])

(deprecated) Add one or more certificates to this listener.

void AddCertificateArns(string id, string[] arns)

Parameters

id System.String

arns System.String[]

Remarks

Stability: Deprecated

AddCertificates(String, IListenerCertificate[])

Add one or more certificates to this listener.

void AddCertificates(string id, IListenerCertificate[] certificates)

Parameters

id System.String

certificates IListenerCertificate[]

AddTargetGroups(String, IAddApplicationTargetGroupsProps)

Load balance incoming requests to the given target groups.

void AddTargetGroups(string id, IAddApplicationTargetGroupsProps props)

Parameters

id System.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 System.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.