Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface AuthenticateJwtOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AuthenticateJwtOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:10.905Z")
@Stability(Stable)
public interface AuthenticateJwtOptions
extends software.amazon.jsii.JsiiSerializable

Options for ListenerAction.authenticateJwt().

Example:

 ApplicationLoadBalancer lb;
 IListenerCertificate certificate;
 ApplicationTargetGroup myTargetGroup;
 // JWT authentication requires HTTPS
 ApplicationListener listener = lb.addListener("Listener", BaseApplicationListenerProps.builder()
         .protocol(ApplicationProtocol.HTTPS)
         .port(443)
         .certificates(List.of(certificate))
         .defaultAction(ListenerAction.authenticateJwt(AuthenticateJwtOptions.builder()
                 .issuer("https://issuer.example.com")
                 .jwksEndpoint("https://issuer.example.com/.well-known/jwks.json")
                 .next(ListenerAction.forward(List.of(myTargetGroup)))
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AuthenticateJwtOptions.Builder	A builder for AuthenticateJwtOptions
static final class	AuthenticateJwtOptions.Jsii$Proxy	An implementation for AuthenticateJwtOptions

Method Summary

Modifier and Type	Method	Description
static AuthenticateJwtOptions.Builder	builder()
String	getIssuer()	The issuer of the JWT token.
String	getJwksEndpoint()	The JWKS (JSON Web Key Set) endpoint URL.
ListenerAction	getNext()	What action to execute next.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIssuer

@Stability(Stable)
@NotNull
String getIssuer()

The issuer of the JWT token.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

Example:

 "https://issuer.example.com";
 

getJwksEndpoint

@Stability(Stable)
@NotNull
String getJwksEndpoint()

The JWKS (JSON Web Key Set) endpoint URL.

The endpoint must be publicly accessible and return the public keys used to verify JWT signatures.

Example:

 "https://issuer.example.com/jwks";
 

getNext

@Stability(Stable)
@NotNull
ListenerAction getNext()

What action to execute next.

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

builder

@Stability(Stable)
static AuthenticateJwtOptions.Builder builder()

Returns:

a AuthenticateJwtOptions.Builder of AuthenticateJwtOptions