Class API

constructor

• new API(name, args, opts?): API

• Parameters

  • name: string
  • args: APIArgs
  • opts: ComponentResourceOptions = {}

  Returns API

Optional Readonly apiPolicy

Readonly deployment

Readonly restAPI

Readonly stage

Optional Readonly staticRoutesBucket

Readonly url

getFunction

• getFunction(route?, method?): Function

• Returns the [aws.lambda.Function] an [EventHandlerRoute] points to. This will either be for the aws.lambda.Function created on your behalf if the route was passed a normal JavaScript/Typescript function, or it will be the [aws.lambda.Function] that was explicitly passed in.

  [route] and [method] can both be elided if this API only has a single [EventHandlerRoute] assigned to it.

  [method] can be elided if [route] only has a single [EventHandlerRoute] assigned to it.

  This method will throw if the provided [route] and [method] do not resolve to a single [aws.lambda.Function]

  Parameters

  • Optional route: string
  • Optional method: Method

  Returns Function