software.amazon.awscdk.services.apigatewayv2.authorizers

Class HttpLambdaAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.authorizers.HttpLambdaAuthorizer

All Implemented Interfaces:

IHttpRouteAuthorizer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.920Z")
 @Stability(value=Experimental)
public class HttpLambdaAuthorizer
extends software.amazon.jsii.JsiiObject
implements IHttpRouteAuthorizer

(experimental) Authorize Http Api routes via a lambda function.

Example:

 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpLambdaAuthorizer;
 import software.amazon.awscdk.services.apigatewayv2.authorizers.HttpLambdaResponseType;
 import software.amazon.awscdk.services.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.myproxy.internal"))
         .path("/books")
         .authorizer(authorizer)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpLambdaAuthorizer.Builder (experimental) 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 and Description
protected	HttpLambdaAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpLambdaAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
	HttpLambdaAuthorizer(String id, IFunction handler) (experimental) Initialize a lambda authorizer to be bound with HTTP route.
	HttpLambdaAuthorizer(String id, IFunction handler, HttpLambdaAuthorizerProps props) (experimental) Initialize a lambda authorizer to be bound with HTTP route.

Method Summary

Modifier and Type	Method and Description
HttpRouteAuthorizerConfig	bind(HttpRouteAuthorizerBindOptions options) (experimental) 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 Detail

HttpLambdaAuthorizer

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

HttpLambdaAuthorizer

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

HttpLambdaAuthorizer

@Stability(value=Experimental)
public HttpLambdaAuthorizer(@NotNull
                                                           String id,
                                                           @NotNull
                                                           IFunction handler,
                                                           @Nullable
                                                           HttpLambdaAuthorizerProps props)

(experimental) 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(value=Experimental)
public HttpLambdaAuthorizer(@NotNull
                                                           String id,
                                                           @NotNull
                                                           IFunction handler)

(experimental) 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 Detail

bind

@Stability(value=Experimental)
 @NotNull
public HttpRouteAuthorizerConfig bind(@NotNull
                                                                               HttpRouteAuthorizerBindOptions options)

(experimental) Bind this authorizer to a specified Http route.

Specified by:

bind in interface IHttpRouteAuthorizer

Parameters:

options - This parameter is required.