Package software.amazon.awscdk.services.elasticloadbalancingv2

Class ApplicationListener

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.166Z") @Stability(Stable) 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();

  • Constructor Details

    • ApplicationListener

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

    • ApplicationListener

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

    • ApplicationListener

      @Stability(Stable) public ApplicationListener(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ApplicationListenerProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromApplicationListenerAttributes

      @Stability(Stable) @NotNull public static IApplicationListener fromApplicationListenerAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ApplicationListenerAttributes attrs)
      Import an existing listener.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • fromLookup

      @Stability(Stable) @NotNull public static IApplicationListener fromLookup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ApplicationListenerLookupOptions options)
      Look up an ApplicationListener.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      options - This parameter is required.

    • addAction

      @Stability(Stable) public void addAction(@NotNull String id, @NotNull 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

      @Stability(Deprecated) @Deprecated public void addCertificateArns(@NotNull String id, @NotNull List<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

      @Stability(Stable) public void addCertificates(@NotNull String id, @NotNull 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

      @Stability(Deprecated) @Deprecated public void addFixedResponse(@NotNull String id, @NotNull AddFixedResponseProps props)
      Deprecated.
      Use addAction() instead
      (deprecated) Add a fixed response.

      Parameters:
      id - This parameter is required.
      props - This parameter is required.

    • addRedirectResponse

      @Stability(Deprecated) @Deprecated public void addRedirectResponse(@NotNull String id, @NotNull AddRedirectResponseProps props)
      Deprecated.
      Use addAction() instead
      (deprecated) Add a redirect response.

      Parameters:
      id - This parameter is required.
      props - This parameter is required.

    • addTargetGroups

      @Stability(Stable) public void addTargetGroups(@NotNull String id, @NotNull 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

      @Stability(Stable) @NotNull public 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, 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

      @Stability(Stable) public 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.

      Specified by:
      registerConnectable in interface IApplicationListener
      Parameters:
      connectable - This parameter is required.
      portRange - This parameter is required.

    • validate

      @Stability(Stable) @NotNull protected List<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

      @Stability(Stable) @NotNull public Connections getConnections()
      Manage connections to this ApplicationListener.
      Specified by:
      getConnections in interface IConnectable

    • getLoadBalancer

      @Stability(Stable) @NotNull public IApplicationLoadBalancer getLoadBalancer()
      Load balancer this listener is associated with.