AwsServerlessApiGatewayRestRouteArgs

interface AwsServerlessApiGatewayRestRouteArgs {
apiKeyRequired?: Input<boolean>;
authorization?: Input<string>;
createInvokePermission?: boolean;
functionKey?: string;
}

API Gateway REST route mapping to the managed Lambda function.

Example

CODE

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

Properties

`apiKeyRequired: Input<boolean>`

Whether API key is required for this method.

`authorization: Input<string>`

Optional API Gateway method authorisation. Defaults to NONE.

`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.