AwsServerlessApiGatewayHttpRouteArgs

interface AwsServerlessApiGatewayHttpRouteArgs {
authorization?: AwsApiGatewayHttpRouteAuthorizationArgs;
createInvokePermission?: boolean;
functionKey?: string;
payloadFormatVersion?: Input<'1.0' | '2.0'>;
timeoutMilliseconds?: Input<number>;
}

API Gateway HTTP route mapping to the managed Lambda function.

Example

CODE

const route: AwsServerlessApiGatewayHttpRouteArgs = {
  functionKey: 'api',
};

Properties

`authorization: AwsApiGatewayHttpRouteAuthorizationArgs`

Optional route authorisation configuration.

`createInvokePermission: boolean`

Whether API Gateway creates the required Lambda invoke permission. Defaults to true.

`functionKey: string`

Optional function key from args.functions that this route invokes. Defaults to the primary function.

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

Payload format version sent to the integration. Defaults to 2.0.

`timeoutMilliseconds: Input<number>`

Optional integration timeout in milliseconds.