HttpLambdaAuthorizer

class aws_cdk.aws_apigatewayv2_authorizers.HttpLambdaAuthorizer(id, handler, *, authorizer_name=None, identity_source=None, response_types=None, results_cache_ttl=None)

Bases: object

Authorize Http Api routes via a lambda function.

ExampleMetadata:

infused

Example:

from aws_cdk.aws_apigatewayv2_authorizers import HttpLambdaAuthorizer, HttpLambdaResponseType
from aws_cdk.aws_apigatewayv2_integrations import HttpUrlIntegration

# This function handles your auth logic
# auth_handler: lambda.Function


authorizer = HttpLambdaAuthorizer("BooksAuthorizer", auth_handler,
    response_types=[HttpLambdaResponseType.SIMPLE]
)

api = apigwv2.HttpApi(self, "HttpApi")

api.add_routes(
    integration=HttpUrlIntegration("BooksIntegration", "https://get-books-proxy.example.com"),
    path="/books",
    authorizer=authorizer
)

Initialize a lambda authorizer to be bound with HTTP route.

Parameters:

  • id (str) – The id of the underlying construct.

  • handler (IFunction)

  • authorizer_name (Optional[str]) – Friendly authorizer name. Default: - same value as id passed in the constructor.

  • identity_source (Optional[Sequence[str]]) – The identity source for which authorization is requested. Default: [‘$request.header.Authorization’]

  • response_types (Optional[Sequence[HttpLambdaResponseType]]) – The types of responses the lambda can return. If HttpLambdaResponseType.SIMPLE is included then response format 2.0 will be used. Default: [HttpLambdaResponseType.IAM]

  • results_cache_ttl (Optional[Duration]) – How long APIGateway should cache the results. Max 1 hour. Disable caching by setting this to Duration.seconds(0). Default: Duration.minutes(5)

Methods

bind(*, route, scope)

Bind this authorizer to a specified Http route.

Parameters:

  • route (IHttpRoute) – The route to which the authorizer is being bound.

  • scope (Construct) – The scope for any constructs created as part of the bind.

Return type:

HttpRouteAuthorizerConfig

Attributes

authorization_type

The authorizationType used for Lambda Authorizer.

authorizer_id

Return the id of the authorizer if it’s been constructed.