Interface IApplicationListener
- All Superinterfaces:
IConnectable
,IConstruct
,software.constructs.IConstruct
,IDependable
,IResource
,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
IApplicationListener.Jsii$Default
- All Known Implementing Classes:
ApplicationListener
,IApplicationListener.Jsii$Proxy
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Internal default implementation forIApplicationListener
.static final class
A proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAction
(String id, AddApplicationActionProps props) Perform the given action on incoming requests.void
addCertificateArns
(String id, List<String> arns) Deprecated.void
addCertificates
(String id, List<IListenerCertificate> certificates) Add one or more certificates to this listener.void
addTargetGroups
(String id, AddApplicationTargetGroupsProps props) Load balance incoming requests to the given target groups.addTargets
(String id, AddApplicationTargetsProps props) Load balance incoming requests to the given load balancing targets.ARN of the listener.void
registerConnectable
(IConnectable connectable, Port portRange) Register that a connectable that has been added to this load balancer.Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable
getConnections
Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getListenerArn
ARN of the listener. -
addAction
Perform the given action on incoming requests.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.- Parameters:
id
- This parameter is required.props
- This parameter is required.
-
addCertificateArns
@Stability(Deprecated) @Deprecated void addCertificateArns(@NotNull String id, @NotNull List<String> arns) Deprecated.useaddCertificates()
(deprecated) Add one or more certificates to this listener.- Parameters:
id
- This parameter is required.arns
- This parameter is required.
-
addCertificates
@Stability(Stable) void addCertificates(@NotNull String id, @NotNull List<IListenerCertificate> certificates) Add one or more certificates to this listener.- Parameters:
id
- This parameter is required.certificates
- This parameter is required.
-
addTargetGroups
@Stability(Stable) void addTargetGroups(@NotNull String id, @NotNull AddApplicationTargetGroupsProps props) 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
- This parameter is required.props
- This parameter is required.
-
addTargets
@Stability(Stable) @NotNull ApplicationTargetGroup addTargets(@NotNull String id, @NotNull AddApplicationTargetsProps props) 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
- This parameter is required.props
- This parameter is required.- Returns:
- The newly created target group
-
registerConnectable
@Stability(Stable) void registerConnectable(@NotNull IConnectable connectable, @NotNull Port portRange) Register that a connectable that has been added to this load balancer.Don't call this directly. It is called by ApplicationTargetGroup.
- Parameters:
connectable
- This parameter is required.portRange
- This parameter is required.
-
addCertificates()