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

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

AwsApiGatewayStage

这些区域有:AwsApiGatewayStage对象提供有关版本 1 Amazon API Gateway 阶段的信息。

示例

"AwsApiGatewayStage": { "DeploymentId": "n7hlmf", "ClientCertificateId": "a1b2c3", "StageName": "Prod", "Description" : "Stage Description", "CacheClusterEnabled": false, "CacheClusterSize" : "1.6", "CacheClusterStatus": "NOT_AVAILABLE", "MethodSettings": [ { "MetricsEnabled": true, "LoggingLevel": "INFO", "DataTraceEnabled": false, "ThrottlingBurstLimit": 100, "ThrottlingRateLimit": 5.0, "CachingEnabled": false, "CacheTtlInSeconds": 300, "CacheDataEncrypted": false, "RequireAuthorizationForCacheControl": true, "UnauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER", "HttpMethod": "POST", "ResourcePath": "/echo" } ], "Variables": {"test": "value"}, "DocumentationVersion": "2.0", "AccessLogSettings": { "Format": "{\"requestId\": \"$context.requestId\", \"extendedRequestId\": \"$context.extendedRequestId\", \"ownerAccountId\": \"$context.accountId\", \"requestAccountId\": \"$context.identity.accountId\", \"callerPrincipal\": \"$context.identity.caller\", \"httpMethod\": \"$context.httpMethod\", \"resourcePath\": \"$context.resourcePath\", \"status\": \"$context.status\", \"requestTime\": \"$context.requestTime\", \"responseLatencyMs\": \"$context.responseLatency\", \"errorMessage\": \"$context.error.message\", \"errorResponseType\": \"$context.error.responseType\", \"apiId\": \"$context.apiId\", \"awsEndpointRequestId\": \"$context.awsEndpointRequestId\", \"domainName\": \"$context.domainName\", \"stage\": \"$context.stage\", \"xrayTraceId\": \"$context.xrayTraceId\", \"sourceIp\": \"$context.identity.sourceIp\", \"user\": \"$context.identity.user\", \"userAgent\": \"$context.identity.userAgent\", \"userArn\": \"$context.identity.userArn\", \"integrationLatency\": \"$context.integrationLatency\", \"integrationStatus\": \"$context.integrationStatus\", \"authorizerIntegrationLatency\": \"$context.authorizer.integrationLatency\" }", "DestinationArn": "arn:aws:logs:us-west-2:111122223333:log-group:SecurityHubAPIAccessLog/Prod" }, "CanarySettings": { "PercentTraffic": 0.0, "DeploymentId": "ul73s8", "StageVariableOverrides" : [ "String" : "String" ], "UseStageCache": false }, "TracingEnabled": false, "CreatedDate": "2018-07-11T10:55:18-07:00", "LastUpdatedDate": "2020-08-26T11:51:04-07:00", "WebAclArn" : "arn:aws:waf-regional:us-west-2:111122223333:webacl/cb606bd8-5b0b-4f0b-830a-dd304e48a822" }

AwsApiGatewayStage 属性

AwsApiGatewayStage 可能具有以下属性。

AccessLogSettings

可选

用于日志记录阶段的访问的设置。

类型:对象

CacheClusterEnabled

可选

指示是否为阶段启用缓存集群。

类型:Boolean

CacheClusterSize

可选

如果启用了缓存集群,则为缓存集群的大小。

类型:字符串

CacheClusterStatus

可选

如果启用了缓存集群,则表示缓存集群的状态。

类型:字符串

CanarySettings

可选

有关舞台中 Canary 部署设置的信息。

类型:对象

ClientCertificateId

可选

阶段的客户端证书的标识符。

类型:字符串

CreatedDate

可选

指示舞台的创建时间。

类型:字符串

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

示例

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

可选

阶段指向的部署的标识符。

类型:字符串

Description

可选

阶段的描述。

类型:字符串

DocumentationVersion

可选

与阶段关联的 API 文档的版本。

类型:字符串

LastUpdatedDate

可选

指示舞台最近更新时间。

类型:字符串

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

示例

"LastUpdatedDate": "2017-03-22T13:22:13.933Z"
MethodSettings

可选

定义舞台的方法设置。

对于每种方法,关键是方法路径,定义如下:

  • 对于单个方法覆盖,关键是<resource_path>/<http_method>. 例如:accounts/DELETE

  • 要覆盖舞台中的所有方法,关键是/*/*.

类型:对象数组

StageName

可选

阶段的名称。

类型:字符串

TracingEnabled

可选

指示活动跟踪是否使用Amazon X-Ray已为阶段启用。

类型:Boolean

Variables

可选

一个定义阶段变量的映射。

变量名称可以包含以下字符:A-Z、a-z、0-9 和 _(下划线)。

变量值可能包含以下字符:

  • 大写字母和小写字母

  • 数字

  • 特殊字符。_ ~:/? # & =、-(连字符)

类型:字符串映射

WebAclArn

可选

与舞台关联的 Web ACL 的 ARN。

类型:字符串

AccessLogSettings

这些区域有:AccessLogSettings对象包含有关用于记录舞台访问权限的设置的信息。

AccessLogSettings 可能具有以下属性。

DestinationArn

可选

接收访问日志的 CloudWatch Logs 日志组或 Kinesis Data Firehose 传输流的 ARN。

对于 Kinesis Data Firehose 传输流,流名称始终以开头amazon-apigateway-.

类型:字符串

Format

可选

数据访问日志的单行格式,由选定项指定$context变量。格式必须至少包括 $context.requestId

类型:字符串

CanarySettings

这些区域有:CanarySettings对象包含有关舞台中 Canary 部署设置的信息。

CanarySettings 可能具有以下属性。

DeploymentId

可选

金丝雀部署的部署标识符。

类型:字符串

PercentTraffic

可选

转换到金丝雀部署的流量百分比。

类型:Number

最小值 0

最大值 100

StageVariableOverrides

可选

在 Canary 发行版部署中覆盖的阶段变量。这些变量包括在金丝雀中引入的新阶段变量。

每个变量都表示为阶段变量名称和变量值之间的字符串到字符串映射。

"variableName" : "variableValue"

类型:对象

UseStageCache

可选

指示金丝雀部署是否使用阶段缓存。

类型:Boolean

MethodSettings

这些区域有:MethodSettings对象定义了舞台的方法设置。

中的每个方法对象MethodSettings可能具有以下属性。

CacheDataEncrypted

可选

指示是否加密缓存的响应。

类型:Boolean

CachingEnabled

可选

指示是为请求缓存还是返回响应。要缓存响应,必须在舞台上启用缓存集群。

类型:Boolean

CacheTtlInSeconds

可选

指定缓存响应的存续时间 (TTL),以秒为单位。TTL 越高,缓存响应的时间越长。

类型:Number

DataTraceEnabled

可选

指示是否为该方法启用数据跟踪日志记录。数据跟踪记录会影响推送到 CloudWatch Logs 的日志条目。

类型:Boolean

HttpMethod

可选

HTTP 方法。您可以将星号 (*) 作为通配符以将方法设置应用于多个方法。

类型:字符串

LoggingLevel

可选

此方法的日志记录级别。日志记录级别会影响推送到 CloudWatch Logs 的日志条目。

如果日志记录级别ERROR,那么日志只包含错误级别的条目。

如果日志记录级别INFO,那么日志包括两者ERROR事件和额外的信息性事件。

类型:字符串

有效值OFF | ERROR | INFO

MetricsEnabled

可选

指示是否为该方法启用 CloudWatch 指标。

类型:Boolean

RequireAuthorizationForCacheControl

可选

指示缓存失效请求是否需要授权。

类型:Boolean

ResourcePath

可选

此方法的资源路径。正斜杠 (/) 被编码为 ~1. 初始斜杠必须包含正斜杠。

例如,路径值 /resource/subresource 必须编码为 /~1resource~1subresource

要指定根路径,请仅使用斜杠 (/)。您可以将星号 (*) 作为通配符以将方法设置应用于多个方法。

类型:字符串

ThrottlingBurstLimit

可选

该方法的限制突发限制。

类型:数字 (i整数)

ThrottlingRateLimit

可选

该方法的限制速率限制。

类型:Number

UnauthorizedCacheControlHeaderStrategy

可选

指示如何处理未经授权的缓存失效请求。

类型:字符串

有效值FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER