AwsApiGatewayV2Api - Amazon Security Hub
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

AwsApiGatewayV2Api

这些区域有:AwsApiGatewayV2Api对象包含有关 Amazon API Gateway 中的版本 2 API 的信息。

示例

"AwsApiGatewayV2Api": { "ApiEndpoint": "https://example.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-03-28T00:32:37Z", "Description": "ApiGatewayV2 Api", "Version": "string", "Name": "my-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "CorsConfiguration": { "AllowOrigins": [ "*" ], "AllowCredentials": true, "ExposeHeaders": [ "string" ], "MaxAge": 3000, "AllowMethods": [ "GET", "PUT", "POST", "DELETE", "HEAD" ], "AllowHeaders": [ "*" ] } }

AwsApiGatewayV2Api 属性

AwsApiGatewayV2Api 可能具有以下属性。

ApiEndpoint

可选

API 的 URI。

类型:字符串

Format: <api-id>.execute-api.<region>.amazonaws.com

阶段名称通常会附加到 URI 以形成已部署 API 阶段的完整路径。

ApiId

可选

API 的标识符。

类型:字符串

ApiKeySelectionExpression

可选

一个 API 键选择表达式。仅 WebSocket API 调用支持。

类型:字符串

CorsConfiguration

可选

一种跨域资源共享 (CORS) 配置。仅支持用于 HTTP API 调用。

类型:对象

CreatedDate

可选

指示 API 的创建时间。

类型:字符串

格式:使用date-time在中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式. 值不能包含空格。

示例

"CreatedDate": "2017-03-22T13:22:13.933Z"
Description

可选

API 的描述。

类型:字符串

Name

可选

API 的名称。

类型:字符串

ProtocolType

可选

API 的 API 协议。

类型:字符串

有效值WEBSOCKET | HTTP

RouteSelectionExpression

可选

API 的路由选择表达式。

对于 HTTP API 调用,必须${request.method} ${request.path}. 这是 HTTP API 调用的默认值。

对于 WebSocket API 调用,没有默认值。

类型:字符串

Version

可选

API 的版本标识符。

类型: 字符串

CorsConfiguration

这些区域有:CorsConfiguration对象包含 API 的跨域资源共享 (CORS) 配置。CORS 仅支持 HTTP API 调用。

CorsConfiguration 可能具有以下属性。

AllowCredentials

可选

指示 CORS 请求是否包含凭证。

类型:Boolean

AllowHeaders

可选

CORS 请求允许的标头。

类型:字符串数组

AllowMethods

可选

CORS 请求允许的方法。

类型:字符串数组

AllowOrigins

可选

CORS 请求允许的来源。

类型:字符串数组

ExposeHeaders

可选

CORS 请求的公开标头。

类型:字符串数组

MaxAge

可选

浏览器缓存印前检查请求结果的秒数。

类型:Number