HttpIamAuthorizer

class aws_cdk.aws_apigatewayv2_authorizers.HttpIamAuthorizer

Bases: object

Authorize HTTP API Routes with IAM.

ExampleMetadata:: infused

Example:

from aws_cdk.aws_apigatewayv2_authorizers import HttpIamAuthorizer
from aws_cdk.aws_apigatewayv2_integrations import HttpUrlIntegration

# principal: iam.AnyPrincipal


authorizer = HttpIamAuthorizer()

http_api = apigwv2.HttpApi(self, "HttpApi",
    default_authorizer=authorizer
)

routes = http_api.add_routes(
    integration=HttpUrlIntegration("BooksIntegration", "https://get-books-proxy.example.com"),
    path="/books/{book}"
)

routes[0].grant_invoke(principal)

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 IAM Authorizer.