AwsServerlessApiGatewayHttpArgs

interface AwsServerlessApiGatewayHttpArgs {
authorizers?: Record<string, AwsApiGatewayHttpJwtAuthorizerArgs | AwsApiGatewayHttpCustomAuthorizerArgs>;
autoDeploy?: Input<boolean>;
customDomain?: AwsServerlessApiGatewayHttpCustomDomainArgs;
description?: Input<string>;
identity: string;
routes?: Record<string, AwsServerlessApiGatewayHttpRouteArgs>;
stageName?: Input<string>;
tags?: Input<Record<string, Input<string>>>;
wafAttachment?: AwsApiGatewayWafAttachmentArgs;
}

Optional API Gateway HTTP capability configuration.

Example

CODE

const apiGatewayHttp: AwsServerlessApiGatewayHttpArgs = {
  identity: 'orders-http-api',
  stageName: '$default',
  routes: { 'GET /health': { functionKey: 'api' } },
};

Properties

`authorizers: Record<string, AwsApiGatewayHttpJwtAuthorizerArgs | AwsApiGatewayHttpCustomAuthorizerArgs>`

Optional HTTP authorizer capability definitions passed through to API Gateway, keyed by authorizer reference key.

`autoDeploy: Input<boolean>`

Whether the stage auto-deploys route changes. Defaults to true.

`customDomain: AwsServerlessApiGatewayHttpCustomDomainArgs`

Optional custom-domain settings passed through to API Gateway.

`description: Input<string>`

Optional API description.

`identity: string`

Stable logical-only identity passed to the composed AwsApiGateway HTTP component.

`routes: Record<string, AwsServerlessApiGatewayHttpRouteArgs>`

Route definitions keyed by raw API Gateway v2 route key. Must contain at least one route unless customDomain.mappingTarget is provided.

`stageName: Input<string>`

Stage name. Defaults to $default.

`tags: Input<Record<string, Input<string>>>`

Optional tags merged with default and component-level tags.

`wafAttachment: AwsApiGatewayWafAttachmentArgs`

Optional WAFv2 web ACL attachment for the effective HTTP API stage.