Interface HttpLambdaAuthorizerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
HttpLambdaAuthorizerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:31:57.397Z")
@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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forHttpLambdaAuthorizerProps
static final class
An implementation forHttpLambdaAuthorizerProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Friendly authorizer name.The identity source for which authorization is requested.default List<HttpLambdaResponseType>
The types of responses the lambda can return.default Duration
How long APIGateway should cache the results.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAuthorizerName
Friendly authorizer name.Default: - same value as `id` passed in the constructor.
-
getIdentitySource
The identity source for which authorization is requested.Default: ['$request.header.Authorization']
-
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:
-
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
- Returns:
- a
HttpLambdaAuthorizerProps.Builder
ofHttpLambdaAuthorizerProps
-