AwsApiGatewayV2ApiDetails - Amazon Security Hub
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

  • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

  • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

  • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

  • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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: