AWS CDK Reference

Appearance

v2.274.0

HttpAuthorizerProps Struct ​

Properties to initialize an instance of HttpAuthorizer.

Source
aws-apigatewayv2/lib/http/authorizer.ts
Type last changed
v2.247.0 · 2 Apr 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import { aws_iam as interfaces_iam } from 'aws-cdk-lib/interfaces';

declare const httpApiRef: apigatewayv2.IHttpApiRef;
declare const roleRef: interfaces_iam.IRoleRef;
const httpAuthorizerProps: apigatewayv2.HttpAuthorizerProps = {
  httpApi: httpApiRef,
  identitySource: ['identitySource'],
  type: apigatewayv2.HttpAuthorizerType.IAM,

  // the properties below are optional
  authorizerName: 'authorizerName',
  authorizerUri: 'authorizerUri',
  enableSimpleResponses: false,
  jwtAudience: ['jwtAudience'],
  jwtIssuer: 'jwtIssuer',
  payloadFormatVersion: apigatewayv2.AuthorizerPayloadVersion.VERSION_1_0,
  resultsCacheTtl: cdk.Duration.minutes(30),
  role: roleRef,
};

Properties ​

authorizerNamestringauthorizer_namestrauthorizerNameStringAuthorizerNamestringAuthorizerName*string#
Name of the authorizer.

Default: id of the HttpAuthorizer construct.

authorizerUristringauthorizer_uristrauthorizerUriStringAuthorizerUristringAuthorizerUri*string#
The authorizer's Uniform Resource Identifier (URI).

Default: required for Request authorizer types

For REQUEST authorizers, this must be a well-formed Lambda function URI.

enableSimpleResponsesbooleanenable_simple_responsesboolenableSimpleResponsesBooleanEnableSimpleResponsesboolEnableSimpleResponses*bool#
Specifies whether a Lambda authorizer returns a response in a simple format.

Default: The lambda authorizer must return an IAM policy as its response

If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy.

httpApiIHttpApiRefhttp_apiIHttpApiRefhttpApiIHttpApiRefHttpApiIHttpApiRefHttpApiIHttpApiRefrequired#
HTTP Api to attach the authorizer to.
identitySourcestring[]identity_sourcetyping.List[str]identitySourceList<String>IdentitySourcestring[]IdentitySource*[]*stringrequired#
The identity source for which authorization is requested.
jwtAudiencestring[]jwt_audiencetyping.List[str]jwtAudienceList<String>JwtAudiencestring[]JwtAudience*[]*string#
A list of the intended recipients of the JWT.

Default: required for JWT authorizer typess.

A valid JWT must provide an aud that matches at least one entry in this list.

jwtIssuerstringjwt_issuerstrjwtIssuerStringJwtIssuerstringJwtIssuer*string#
The base domain of the identity provider that issues JWT.

Default: required for JWT authorizer types.

payloadFormatVersionAuthorizerPayloadVersionpayload_format_versionAuthorizerPayloadVersionpayloadFormatVersionAuthorizerPayloadVersionPayloadFormatVersionAuthorizerPayloadVersionPayloadFormatVersionAuthorizerPayloadVersion#
Specifies the format of the payload sent to an HTTP API Lambda authorizer.

Default: AuthorizerPayloadVersion.VERSION_2_0 if the authorizer type is HttpAuthorizerType.LAMBDA

resultsCacheTtlDurationresults_cache_ttlDurationresultsCacheTtlDurationResultsCacheTtlDurationResultsCacheTtlDuration#
How long APIGateway should cache the results.

Default: API Gateway will not cache authorizer responses

Max 1 hour.

roleIRoleRefroleIRoleRefroleIRoleRefRoleIRoleRefRoleIRoleRef#
The IAM role that the API Gateway service assumes while invoking the authorizer.

Default: No role

Supported only for REQUEST authorizers.