Get
Constructors
Properties
The default endpoint for an API. For example: https://abcdef.execute-api.us-west-2.amazonaws.com .
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
The description of the API.
Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
The IP address types that can invoke the API. Use ipv4 to allow only IPv4 addresses to invoke your API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your API. Don’t use IP address type for an HTTP API based on an OpenAPI specification. Instead, specify the IP address type in the OpenAPI specification.
The route selection expression for the API. For HTTP APIs, the `routeSelectionExpression` must be `${request.method} ${request.path}`. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.