AwsApiGatewayHttpRouteArgs

interface AwsApiGatewayHttpRouteArgs {
authorization?: AwsApiGatewayHttpRouteAuthorizationArgs;
integration: AwsApiGatewayHttpRouteIntegrationArgs;
payloadFormatVersion?: Input<'1.0' | '2.0'>;
routeKey: Input<string>;
timeoutMilliseconds?: Input<number>;
}

HTTP route definition for AwsApiGatewayHttpArgs.

Remarks

When supplied through AwsApiGatewayHttpArgs.routes, routeKey is the map key and is omitted from the value; the map key is both the stable route identity and the value forwarded to the provider as the API Gateway v2 route key.

Example

CODE

const route: AwsApiGatewayHttpRouteArgs = {
  routeKey: 'GET /health',
  integration: {
    type: 'lambda',
    targetArn: lambdaFunction.arn,
    createInvokePermission: false,
  },
};

Properties

`authorization: AwsApiGatewayHttpRouteAuthorizationArgs`

Optional route authorisation configuration. Defaults to NONE.

`integration: AwsApiGatewayHttpRouteIntegrationArgs`

Typed integration settings.

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

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

`routeKey: Input<string>`

Route key in API Gateway v2 format (for example GET /health). Provided as the map key in AwsApiGatewayHttpArgs.routes.

`timeoutMilliseconds: Input<number>`

Optional integration timeout in milliseconds.