HttpAuthorizerProps Struct
Properties to initialize an instance of HttpAuthorizer.
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
authorizerNameoptionalstringauthorizer_nameoptionalstrauthorizerNameoptionalStringAuthorizerNameoptionalstringAuthorizerNameoptional*string#Name of the authorizer.
Default: id of the HttpAuthorizer construct.
authorizerUrioptionalstringauthorizer_urioptionalstrauthorizerUrioptionalStringAuthorizerUrioptionalstringAuthorizerUrioptional*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.
enableSimpleResponsesoptionalbooleanenable_simple_responsesoptionalboolenableSimpleResponsesoptionalBooleanEnableSimpleResponsesoptionalboolEnableSimpleResponsesoptional*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.
jwtAudienceoptionalstring[]jwt_audienceoptionaltyping.List[str]jwtAudienceoptionalList<String>JwtAudienceoptionalstring[]JwtAudienceoptional*[]*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.
jwtIssueroptionalstringjwt_issueroptionalstrjwtIssueroptionalStringJwtIssueroptionalstringJwtIssueroptional*string#The base domain of the identity provider that issues JWT.
Default: required for JWT authorizer types.
payloadFormatVersionoptionalAuthorizerPayloadVersionpayload_format_versionoptionalAuthorizerPayloadVersionpayloadFormatVersionoptionalAuthorizerPayloadVersionPayloadFormatVersionoptionalAuthorizerPayloadVersionPayloadFormatVersionoptionalAuthorizerPayloadVersion#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
resultsCacheTtloptionalDurationresults_cache_ttloptionalDurationresultsCacheTtloptionalDurationResultsCacheTtloptionalDurationResultsCacheTtloptionalDuration#How long APIGateway should cache the results.
Default: API Gateway will not cache authorizer responses
Max 1 hour.
roleoptionalIRoleRefroleoptionalIRoleRefroleoptionalIRoleRefRoleoptionalIRoleRefRoleoptionalIRoleRef#The IAM role that the API Gateway service assumes while invoking the authorizer.
Default: No role
Supported only for REQUEST authorizers.
typeHttpAuthorizerTypetypeHttpAuthorizerTypetypeHttpAuthorizerTypeTypeHttpAuthorizerTypeTypeHttpAuthorizerTyperequired#The type of authorizer.