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

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

AwsApiGatewayRestApi

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

示例

AwsApiGatewayRestApi: { "Id": "exampleapi", "Name": "Security Hub", "Description": "Amazon Security Hub", "CreatedDate": "2018-11-18T10:20:05-08:00", "Version": "2018-10-26", "BinaryMediaTypes" : ["-'*~1*'"], "MinimumCompressionSize": 1024, "ApiKeySource": "AWS_ACCOUNT_ID", "EndpointConfiguration": { "Types": [ "REGIONAL" ] } }

AwsApiGatewayRestApi 属性

AwsApiGatewayRestApi 可能具有以下属性。

ApiKeySource

可选

用于根据使用计划对请求进行计量的 API 键的源。

HEADER指示是否从请求的 X-API-Key 标头读取 API 密钥。

AUTHORIZER指示是否从UsageIdentifierKey来自自定义授权方。

类型:字符串

有效值HEADER | AUTHORIZER

BinaryMediaTypes

可选

REST API 支持的二进制媒体类型的列表。

类型:字符串数组

CreatedDate

可选

指示 API 的创建时间。

类型:字符串

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

例如:

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

可选

REST API 的描述。

类型:字符串

EndpointConfiguration

可选

REST API 的终端配置。

类型:对象

Id

可选

REST API 的标识符。

类型:字符串

MinimumCompressionSize

可选

启用压缩之前有效负载的最小大小(以字节为单位)。

如果null,那么压缩将被禁用。

如果为 0,则所有有效载荷都被压缩。

类型:Number

最小值 0

最大值 10.485,760

Name

可选

REST API 的名称。

类型:字符串

Version

可选

REST API 的版本标识符。

类型:字符串

EndpointConfiguration

这些区域有:EndPointConfiguration对象包含有关 API 终端节点的信息。

EndPointConfiguration 可能具有以下属性。

Types

可选

REST API 的终端节点类型列表。

对于边缘优化的 API,终端节点类型为EDGE. 对于区域 API,终端节点类型为REGIONAL. 对于私有 API,终端节点类型为PRIVATE.

类型:字符串数组

有效值EDGE | REGIONAL | PRIVATE