Package software.amazon.awscdk.aws_apigatewayv2_authorizers

Class HttpLambdaAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpLambdaAuthorizer

All Implemented Interfaces:

IHttpRouteAuthorizer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:21.442Z")
@Stability(Stable)
public class HttpLambdaAuthorizer
extends software.amazon.jsii.JsiiObject
implements IHttpRouteAuthorizer

Authorize Http Api routes via a lambda function.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpLambdaAuthorizer;
 import software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpLambdaResponseType;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpUrlIntegration;
 // This function handles your auth logic
 Function authHandler;
 HttpLambdaAuthorizer authorizer = HttpLambdaAuthorizer.Builder.create("BooksAuthorizer", authHandler)
         .responseTypes(List.of(HttpLambdaResponseType.SIMPLE))
         .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	HttpLambdaAuthorizer.Builder	A fluent builder for HttpLambdaAuthorizer.

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
	HttpLambdaAuthorizer(String id, IFunction handler)	Initialize a lambda authorizer to be bound with HTTP route.
	HttpLambdaAuthorizer(String id, IFunction handler, HttpLambdaAuthorizerProps props)	Initialize a lambda authorizer to be bound with HTTP route.
protected	HttpLambdaAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpLambdaAuthorizer(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

HttpLambdaAuthorizer

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

HttpLambdaAuthorizer

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

HttpLambdaAuthorizer

@Stability(Stable)
public HttpLambdaAuthorizer(@NotNull
 String id,
 @NotNull
 IFunction handler,
 @Nullable
 HttpLambdaAuthorizerProps props)

Initialize a lambda authorizer to be bound with HTTP route.

Parameters:

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

handler - This parameter is required.

props - Properties to configure the authorizer.

HttpLambdaAuthorizer

@Stability(Stable)
public HttpLambdaAuthorizer(@NotNull
 String id,
 @NotNull
 IFunction handler)

Initialize a lambda authorizer to be bound with HTTP route.

Parameters:

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

handler - 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.