Interface EndpointOptions

The existing Lambda function to integrate with the API Gateway.

This Lambda function will be invoked whenever a request is made to the API Gateway endpoint.

The path to expose on the API Gateway.

This is the URL path that clients will use to invoke the Lambda function.

Default

'/'
Copy

Example

const apiPath = '/my-endpoint';
Copy

The HTTP method to accept on the API Gateway.

Default

apigateway.HttpMethod.ANY
Copy

Example

import * as apigateway from 'aws-cdk-lib/aws-apigatewayv2';

const apiMethod = apigateway.HttpMethod.POST;
Copy

CORS preflight options for the API Gateway.

Configures Cross-Origin Resource Sharing (CORS) to allow web applications running at one domain to access resources from another domain.

Example

import * as apigateway from 'aws-cdk-lib/aws-apigatewayv2';

const corsOptions = {
  allowOrigins: ['https://mydomain.com'],
  allowMethods: [
    apigateway.CorsHttpMethod.GET,
    apigateway.CorsHttpMethod.POST,
  ],
  allowHeaders: ['Content-Type', 'Authorization'],
};
Copy