Package software.amazon.awscdk.aws_apigatewayv2_authorizers

Class HttpJwtAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpJwtAuthorizer

All Implemented Interfaces:

IHttpRouteAuthorizer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.242Z")
@Stability(Stable)
public class HttpJwtAuthorizer
extends software.amazon.jsii.JsiiObject
implements IHttpRouteAuthorizer

Authorize Http Api routes on whether the requester is registered as part of an AWS Cognito user pool.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpJwtAuthorizer;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpUrlIntegration;
 String issuer = "https://test.us.auth0.com";
 HttpJwtAuthorizer authorizer = HttpJwtAuthorizer.Builder.create("BooksAuthorizer", issuer)
         .jwtAudience(List.of("3131231"))
         .build();
 HttpApi api = new HttpApi(this, "HttpApi");
 api.addRoutes(AddRoutesOptions.builder()
         .integration(new HttpUrlIntegration("BooksIntegration", "https://get-books-proxy.example.com"))
         .path("/books")
         .authorizer(authorizer)
         .build());
 

Nested Class Summary

Nested Classes

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

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.apigatewayv2.IHttpRouteAuthorizer

IHttpRouteAuthorizer.Jsii$Default, IHttpRouteAuthorizer.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpJwtAuthorizer(String id, String jwtIssuer, HttpJwtAuthorizerProps props)	Initialize a JWT authorizer to be bound with HTTP route.
protected	HttpJwtAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpJwtAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
HttpRouteAuthorizerConfig	bind(HttpRouteAuthorizerBindOptions options)	Bind this authorizer to a specified Http route.

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 Details

HttpJwtAuthorizer

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

HttpJwtAuthorizer

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

HttpJwtAuthorizer

@Stability(Stable)
public HttpJwtAuthorizer(@NotNull
 String id,
 @NotNull
 String jwtIssuer,
 @NotNull
 HttpJwtAuthorizerProps props)

Initialize a JWT authorizer to be bound with HTTP route.

Parameters:

id - The id of the underlying construct. This parameter is required.

jwtIssuer - The base domain of the identity provider that issues JWT. This parameter is required.

props - Properties to configure the authorizer. This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public HttpRouteAuthorizerConfig bind(@NotNull
 HttpRouteAuthorizerBindOptions options)

Bind this authorizer to a specified Http route.

Specified by:

bind in interface IHttpRouteAuthorizer

Parameters:

options - This parameter is required.