Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiGatewayProxyInput

A wrapper object holding the Amazon API Gateway endpoint input.

Hierarchy

  • ApiGatewayProxyInput

Index

Properties

Properties

Optional EndpointType

EndpointType: ApiGatewayEndpointType | string

The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) endpoints for Amazon API Gateway that have been granted access.

Optional StageName

StageName: undefined | string

The name of the API Gateway stage. The name defaults to prod.