software.amazon.awscdk.services.elasticloadbalancingv2

Class ListenerAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.elasticloadbalancingv2.ListenerAction

All Implemented Interfaces:

IListenerAction, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

AuthenticateCognitoAction

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.122Z")
 @Stability(value=Stable)
public class ListenerAction
extends software.amazon.jsii.JsiiObject
implements IListenerAction

What to do when a client makes a request to a listener.

Some actions can be combined with other ones (specifically, you can perform authentication before serving the request).

Multiple actions form a linked chain; the chain must always terminate in a (weighted)forward, fixedResponse or redirect action.

If an action supports chaining, the next action can be indicated by passing it in the next property.

(Called ListenerAction instead of the more strictly correct ListenerAction because this is the class most users interact with, and we want to make it not too visually overwhelming).

Example:

 ApplicationListener listener;
 listener.addAction("Fixed", AddApplicationActionProps.builder()
         .priority(10)
         .conditions(List.of(ListenerCondition.pathPatterns(List.of("/ok"))))
         .action(ListenerAction.fixedResponse(200, FixedResponseOptions.builder()
                 .contentType(ContentType.TEXT_PLAIN)
                 .messageBody("OK")
                 .build()))
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IListenerAction.Jsii$Default, IListenerAction.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListenerAction(CfnListener.ActionProperty actionJson) Create an instance of ListenerAction.
protected	ListenerAction(CfnListener.ActionProperty actionJson, ListenerAction next) Create an instance of ListenerAction.
protected	ListenerAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ListenerAction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static ListenerAction	authenticateOidc(AuthenticateOidcOptions options) Authenticate using an identity provider (IdP) that is compliant with OpenID Connect (OIDC).
void	bind(software.constructs.Construct scope, IApplicationListener listener) Called when the action is being used in a listener.
void	bind(software.constructs.Construct scope, IApplicationListener listener, software.constructs.IConstruct associatingConstruct) Called when the action is being used in a listener.
static ListenerAction	fixedResponse(Number statusCode) Return a fixed response.
static ListenerAction	fixedResponse(Number statusCode, FixedResponseOptions options) Return a fixed response.
static ListenerAction	forward(List<? extends IApplicationTargetGroup> targetGroups) Forward to one or more Target Groups.
static ListenerAction	forward(List<? extends IApplicationTargetGroup> targetGroups, ForwardOptions options) Forward to one or more Target Groups.
protected ListenerAction	getNext()
static ListenerAction	redirect(RedirectOptions options) Redirect to a different URI.
List<CfnListener.ActionProperty>	renderActions() Render the actions in this chain.
protected List<CfnListener.ActionProperty>	renumber(List<CfnListener.ActionProperty> actions) Renumber the "order" fields in the actions array.
static ListenerAction	weightedForward(List<? extends WeightedTargetGroup> targetGroups) Forward to one or more Target Groups which are weighted differently.
static ListenerAction	weightedForward(List<? extends WeightedTargetGroup> targetGroups, ForwardOptions options) Forward to one or more Target Groups which are weighted differently.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ListenerAction

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

ListenerAction

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

ListenerAction

@Stability(value=Stable)
protected ListenerAction(@NotNull
                                                  CfnListener.ActionProperty actionJson,
                                                  @Nullable
                                                  ListenerAction next)

Create an instance of ListenerAction.

The default class should be good enough for most cases and should be created by using one of the static factory functions, but allow overriding to make sure we allow flexibility for the future.

Parameters:

actionJson - This parameter is required.

next -

ListenerAction

@Stability(value=Stable)
protected ListenerAction(@NotNull
                                                  CfnListener.ActionProperty actionJson)

Create an instance of ListenerAction.

The default class should be good enough for most cases and should be created by using one of the static factory functions, but allow overriding to make sure we allow flexibility for the future.

Parameters:

actionJson - This parameter is required.

Method Detail

authenticateOidc

@Stability(value=Stable)
 @NotNull
public static ListenerAction authenticateOidc(@NotNull
                                                                                 AuthenticateOidcOptions options)

Authenticate using an identity provider (IdP) that is compliant with OpenID Connect (OIDC).

Parameters:

options - This parameter is required.

See Also:

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/listener-authenticate-users.html#oidc-requirements

fixedResponse

@Stability(value=Stable)
 @NotNull
public static ListenerAction fixedResponse(@NotNull
                                                                              Number statusCode,
                                                                              @Nullable
                                                                              FixedResponseOptions options)

Return a fixed response.

Parameters:

statusCode - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#fixed-response-actions

fixedResponse

@Stability(value=Stable)
 @NotNull
public static ListenerAction fixedResponse(@NotNull
                                                                              Number statusCode)

Return a fixed response.

Parameters:

statusCode - This parameter is required.

See Also:

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#fixed-response-actions

forward

@Stability(value=Stable)
 @NotNull
public static ListenerAction forward(@NotNull
                                                                        List<? extends IApplicationTargetGroup> targetGroups,
                                                                        @Nullable
                                                                        ForwardOptions options)

Forward to one or more Target Groups.

Parameters:

targetGroups - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#forward-actions

forward

@Stability(value=Stable)
 @NotNull
public static ListenerAction forward(@NotNull
                                                                        List<? extends IApplicationTargetGroup> targetGroups)

Forward to one or more Target Groups.

Parameters:

targetGroups - This parameter is required.

See Also:

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#forward-actions

redirect

@Stability(value=Stable)
 @NotNull
public static ListenerAction redirect(@NotNull
                                                                         RedirectOptions options)

Redirect to a different URI.

A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.

You can reuse URI components using the following reserved keywords:

• #{protocol}
• #{host}
• #{port}
• #{path} (the leading "/" is removed)
• #{query}

For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".

Parameters:

options - This parameter is required.

See Also:

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#redirect-actions

weightedForward

@Stability(value=Stable)
 @NotNull
public static ListenerAction weightedForward(@NotNull
                                                                                List<? extends WeightedTargetGroup> targetGroups,
                                                                                @Nullable
                                                                                ForwardOptions options)

Forward to one or more Target Groups which are weighted differently.

Parameters:

targetGroups - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#forward-actions

weightedForward

@Stability(value=Stable)
 @NotNull
public static ListenerAction weightedForward(@NotNull
                                                                                List<? extends WeightedTargetGroup> targetGroups)

Forward to one or more Target Groups which are weighted differently.

Parameters:

targetGroups - This parameter is required.

See Also:

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#forward-actions

bind

@Stability(value=Stable)
public void bind(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          IApplicationListener listener,
                                          @Nullable
                                          software.constructs.IConstruct associatingConstruct)

Called when the action is being used in a listener.

Parameters:

scope - This parameter is required.

listener - This parameter is required.

associatingConstruct -

bind

@Stability(value=Stable)
public void bind(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          IApplicationListener listener)

Called when the action is being used in a listener.

Parameters:

scope - This parameter is required.

listener - This parameter is required.

renderActions

@Stability(value=Stable)
 @NotNull
public List<CfnListener.ActionProperty> renderActions()

Render the actions in this chain.

Specified by:

renderActions in interface IListenerAction

renumber

@Stability(value=Stable)
 @NotNull
protected List<CfnListener.ActionProperty> renumber(@NotNull
                                                                                       List<CfnListener.ActionProperty> actions)

Renumber the "order" fields in the actions array.

We don't number for 0 or 1 elements, but otherwise number them 1...#actions so ELB knows about the right order.

Do this in ListenerAction instead of in Listener so that we give users the opportunity to override by subclassing and overriding renderActions.

Parameters:

actions - This parameter is required.

getNext

@Stability(value=Stable)
 @Nullable
protected ListenerAction getNext()