AwsApiGatewayHttpCustomAuthorizerArgs

interface AwsApiGatewayHttpCustomAuthorizerArgs {
authorizerCredentialsArn?: Input<string>;
authorizerFunction?: AwsApiGatewayLambdaFunctionReference;
authorizerPayloadFormatVersion?: Input<'1.0' | '2.0'>;
authorizerResultTtlInSeconds?: Input<number>;
authorizerUri?: Input<string>;
createInvokePermission?: boolean;
enableSimpleResponses?: Input<boolean>;
identitySources: Input<string>[];
name: Input<string>;
type: 'CUSTOM';
}

HTTP Lambda authorizer capability settings.

Example

CODE

const authorizer: AwsApiGatewayHttpCustomAuthorizerArgs = {
  type: 'CUSTOM',
  name: 'orders-request-authorizer',
  authorizerUri: authorizerFunction.invokeArn,
  createInvokePermission: false,
  identitySources: ['$request.header.Authorization'],
};

Properties

`authorizerCredentialsArn: Input<string>`

Optional IAM role ARN used by API Gateway to invoke the authorizer.

`authorizerFunction: AwsApiGatewayLambdaFunctionReference`

Managed Lambda function reference for the REQUEST authorizer. Mutually exclusive with authorizerUri.

`authorizerPayloadFormatVersion: Input<'1.0' | '2.0'>`

Optional payload format version. Defaults to 2.0.

`authorizerResultTtlInSeconds: Input<number>`

Optional authorizer cache TTL in seconds.

`authorizerUri: Input<string>`

Externally permissioned Lambda invoke ARN for the REQUEST authorizer. Mutually exclusive with authorizerFunction.

`createInvokePermission: boolean`

Whether to create the required Lambda resource-policy permission. Defaults to true for authorizerFunction.

`enableSimpleResponses: Input<boolean>`

Optional simple-response mode toggle.

`identitySources: Input<string>[]`

Identity sources evaluated by API Gateway for this authorizer.

`name: Input<string>`

Explicit authorizer purpose name.

`type: 'CUSTOM'`

Authorizer capability type.