software.amazon.awscdk.services.elasticloadbalancingv2

Class ApplicationListener

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.elasticloadbalancingv2.BaseListener

software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListener

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, IApplicationListener

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.973Z")
public class ApplicationListener
extends BaseListener
implements IApplicationListener

Define an ApplicationListener.

Example:

 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 ApplicationLoadBalancer alb;
 ApplicationListener listener = alb.addListener("Listener", BaseApplicationListenerProps.builder().port(80).build());
 ApplicationTargetGroup targetGroup = listener.addTargets("Fleet", AddApplicationTargetsProps.builder().port(80).build());
 ServerDeploymentGroup deploymentGroup = ServerDeploymentGroup.Builder.create(this, "DeploymentGroup")
         .loadBalancer(LoadBalancer.application(targetGroup))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationListener.Builder A fluent builder for ApplicationListener.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationListener

IApplicationListener.Jsii$Default, IApplicationListener.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationListener(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApplicationListener(software.amazon.jsii.JsiiObjectRef objRef)
	ApplicationListener(software.constructs.Construct scope, java.lang.String id, ApplicationListenerProps props)

Method Summary

Modifier and Type	Method and Description
void	addAction(java.lang.String id, AddApplicationActionProps props) Perform the given default action on incoming requests.
void	addCertificateArns(java.lang.String id, java.util.List<java.lang.String> arns) Deprecated. Use `addCertificates` instead.
void	addCertificates(java.lang.String id, java.util.List<IListenerCertificate> certificates) Add one or more certificates to this listener.
void	addFixedResponse(java.lang.String id, AddFixedResponseProps props) Deprecated. Use `addAction()` instead
void	addRedirectResponse(java.lang.String id, AddRedirectResponseProps props) Deprecated. Use `addAction()` instead
void	addTargetGroups(java.lang.String id, AddApplicationTargetGroupsProps props) Load balance incoming requests to the given target groups.
ApplicationTargetGroup	addTargets(java.lang.String id, AddApplicationTargetsProps props) Load balance incoming requests to the given load balancing targets.
static IApplicationListener	fromApplicationListenerAttributes(software.constructs.Construct scope, java.lang.String id, ApplicationListenerAttributes attrs) Import an existing listener.
static IApplicationListener	fromLookup(software.constructs.Construct scope, java.lang.String id, ApplicationListenerLookupOptions options) Look up an ApplicationListener.
Connections	getConnections() Manage connections to this ApplicationListener.
IApplicationLoadBalancer	getLoadBalancer() Load balancer this listener is associated with.
void	registerConnectable(IConnectable connectable, Port portRange) Register that a connectable that has been added to this load balancer.
protected java.util.List<java.lang.String>	validate() Validate this listener.

Methods inherited from class software.amazon.awscdk.services.elasticloadbalancingv2.BaseListener

getListenerArn

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationListener

getListenerArn

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

ApplicationListener

protected ApplicationListener(software.amazon.jsii.JsiiObjectRef objRef)

ApplicationListener

protected ApplicationListener(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ApplicationListener

public ApplicationListener(software.constructs.Construct scope,
                           java.lang.String id,
                           ApplicationListenerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromApplicationListenerAttributes

public static IApplicationListener fromApplicationListenerAttributes(software.constructs.Construct scope,
                                                                     java.lang.String id,
                                                                     ApplicationListenerAttributes attrs)

Import an existing listener.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

fromLookup

public static IApplicationListener fromLookup(software.constructs.Construct scope,
                                              java.lang.String id,
                                              ApplicationListenerLookupOptions options)

Look up an ApplicationListener.

Parameters:

scope - This parameter is required.

id - This parameter is required.

options - This parameter is required.

addAction

public void addAction(java.lang.String id,
                      AddApplicationActionProps props)

Perform the given default 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. At least one Action must be added without conditions (which becomes the default Action).

Specified by:

addAction in interface IApplicationListener

Parameters:

id - This parameter is required.

props - This parameter is required.

addCertificateArns

@Deprecated
public void addCertificateArns(java.lang.String id,
                                           java.util.List<java.lang.String> arns)

Deprecated. Use `addCertificates` instead.

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

After the first certificate, this creates ApplicationListenerCertificates resources since cloudformation requires the certificates array on the listener resource to have a length of 1.

Specified by:

addCertificateArns in interface IApplicationListener

Parameters:

id - This parameter is required.

arns - This parameter is required.

addCertificates

public void addCertificates(java.lang.String id,
                            java.util.List<IListenerCertificate> certificates)

Add one or more certificates to this listener.

After the first certificate, this creates ApplicationListenerCertificates resources since cloudformation requires the certificates array on the listener resource to have a length of 1.

Specified by:

addCertificates in interface IApplicationListener

Parameters:

id - This parameter is required.

certificates - This parameter is required.

addFixedResponse

@Deprecated
public void addFixedResponse(java.lang.String id,
                                         AddFixedResponseProps props)

Deprecated. Use `addAction()` instead

(deprecated) Add a fixed response.

Parameters:

id - This parameter is required.

props - This parameter is required.

addRedirectResponse

@Deprecated
public void addRedirectResponse(java.lang.String id,
                                            AddRedirectResponseProps props)

Deprecated. Use `addAction()` instead

(deprecated) Add a redirect response.

Parameters:

id - This parameter is required.

props - This parameter is required.

addTargetGroups

public void addTargetGroups(java.lang.String id,
                            AddApplicationTargetGroupsProps props)

Load balance incoming requests to the given target groups.

All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use addAction().

It's possible to add routing conditions to the TargetGroups added in this way. At least one TargetGroup must be added without conditions (which will become the default Action for this listener).

Specified by:

addTargetGroups in interface IApplicationListener

Parameters:

id - This parameter is required.

props - This parameter is required.

addTargets

public ApplicationTargetGroup addTargets(java.lang.String id,
                                         AddApplicationTargetsProps props)

Load balance incoming requests to the given load balancing targets.

This method implicitly creates an ApplicationTargetGroup for the targets involved, and a 'forward' action to route traffic to the given TargetGroup.

If you want more control over the precise setup, create the TargetGroup and use addAction yourself.

It's possible to add conditions to the targets added in this way. At least one set of targets must be added without conditions.

Specified by:

addTargets in interface IApplicationListener

Parameters:

id - This parameter is required.

props - This parameter is required.

Returns:

The newly created target group

registerConnectable

public void registerConnectable(IConnectable connectable,
                                Port portRange)

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

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

Specified by:

registerConnectable in interface IApplicationListener

Parameters:

connectable - This parameter is required.

portRange - This parameter is required.

validate

protected java.util.List<java.lang.String> validate()

Validate this listener.

Overrides:

validate in class BaseListener

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getConnections

public Connections getConnections()

Manage connections to this ApplicationListener.

Specified by:

getConnections in interface IConnectable

getLoadBalancer

public IApplicationLoadBalancer getLoadBalancer()

Load balancer this listener is associated with.