AwsApiGatewayV2ApiDetails
Contains information about a version 2 API in Amazon API Gateway.
Contents
- ApiEndpoint
-
The URI of the API.
Uses the format
<api-id>.execute-api.<region>.amazonaws.com
The stage name is typically appended to the URI to form a complete path to a deployed API stage.
Type: String
Pattern:
.*\S.*
Required: No
- ApiId
-
The identifier of the API.
Type: String
Pattern:
.*\S.*
Required: No
- ApiKeySelectionExpression
-
An API key selection expression. Supported only for WebSocket APIs.
Type: String
Pattern:
.*\S.*
Required: No
- CorsConfiguration
-
A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
Type: AwsCorsConfiguration object
Required: No
- CreatedDate
-
Indicates when the API was created.
Uses the
date-time
format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T
. For example,2020-03-22T13:22:13.933Z
.Type: String
Pattern:
.*\S.*
Required: No
- Description
-
A description of the API.
Type: String
Pattern:
.*\S.*
Required: No
- Name
-
The name of the API.
Type: String
Pattern:
.*\S.*
Required: No
- ProtocolType
-
The API protocol for the API.
Valid values:
WEBSOCKET
|HTTP
Type: String
Pattern:
.*\S.*
Required: No
- RouteSelectionExpression
-
The route selection expression for the API.
For HTTP APIs, must be
${request.method} ${request.path}
. This is the default value for HTTP APIs.For WebSocket APIs, there is no default value.
Type: String
Pattern:
.*\S.*
Required: No
- Version
-
The version identifier for the API.
Type: String
Pattern:
.*\S.*
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: