class HttpIamAuthorizer

Language	Type name
.NET	Amazon.CDK.AwsApigatewayv2Authorizers.HttpIamAuthorizer
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2authorizers#HttpIamAuthorizer
Java	software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpIamAuthorizer
Python	aws_cdk.aws_apigatewayv2_authorizers.HttpIamAuthorizer
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2_authorizers » HttpIamAuthorizer

Implements IHttpRouteAuthorizer

Authorize HTTP API Routes with IAM.

Example

import { HttpIamAuthorizer } from 'aws-cdk-lib/aws-apigatewayv2-authorizers';
import { HttpUrlIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';

declare const principal: iam.AnyPrincipal;

const authorizer = new HttpIamAuthorizer();

const httpApi = new apigwv2.HttpApi(this, 'HttpApi', {
  defaultAuthorizer: authorizer,
});

const routes = httpApi.addRoutes({
  integration: new HttpUrlIntegration('BooksIntegration', 'https://get-books-proxy.example.com'),
  path: '/books/{book}',
});

routes[0].grantInvoke(principal);

Initializer

new HttpIamAuthorizer()

Properties

Name	Type	Description
authorizationType	HttpAuthorizerType	The authorizationType used for IAM Authorizer.

---

authorizationType

Type: HttpAuthorizerType

The authorizationType used for IAM Authorizer.

Methods

Name	Description
bind(_options)	Bind this authorizer to a specified Http route.

---

bind(_options)

public bind(_options: HttpRouteAuthorizerBindOptions): HttpRouteAuthorizerConfig

Parameters

• _options HttpRouteAuthorizerBindOptions

Returns

• HttpRouteAuthorizerConfig

Bind this authorizer to a specified Http route.