Package software.amazon.awscdk.aws_apigatewayv2_authorizers

Interface HttpLambdaAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpLambdaAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:52.734Z")
@Stability(Stable)
public interface HttpLambdaAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

Properties to initialize HttpTokenAuthorizer.

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	Interface	Description
static final class	HttpLambdaAuthorizerProps.Builder	A builder for HttpLambdaAuthorizerProps
static final class	HttpLambdaAuthorizerProps.Jsii$Proxy	An implementation for HttpLambdaAuthorizerProps

Method Summary

Modifier and Type	Method	Description
static HttpLambdaAuthorizerProps.Builder	builder()
default String	getAuthorizerName()	Friendly authorizer name.
default List<String>	getIdentitySource()	The identity source for which authorization is requested.
default List<HttpLambdaResponseType>	getResponseTypes()	The types of responses the lambda can return.
default Duration	getResultsCacheTtl()	How long APIGateway should cache the results.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizerName

@Stability(Stable)
@Nullable
default String getAuthorizerName()

Friendly authorizer name.

Default: - same value as `id` passed in the constructor.

getIdentitySource

@Stability(Stable)
@Nullable
default List<String> getIdentitySource()

The identity source for which authorization is requested.

Default: ['$request.header.Authorization']

getResponseTypes

@Stability(Stable)
@Nullable
default List<HttpLambdaResponseType> getResponseTypes()

The types of responses the lambda can return.

If HttpLambdaResponseType.SIMPLE is included then response format 2.0 will be used.

Default: [HttpLambdaResponseType.IAM]

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html#http-api-lambda-authorizer.payload-format-response

getResultsCacheTtl

@Stability(Stable)
@Nullable
default Duration getResultsCacheTtl()

How long APIGateway should cache the results.

Max 1 hour. Disable caching by setting this to Duration.seconds(0).

Default: Duration.minutes(5)

builder

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

Returns:

a HttpLambdaAuthorizerProps.Builder of HttpLambdaAuthorizerProps