AwsApiGatewayMethodSettings - AWS Security Hub

AwsApiGatewayMethodSettings

Defines settings for a method for the stage.

Contents

CacheDataEncrypted

Indicates whether the cached responses are encrypted.

Type: Boolean

Required: No

CacheTtlInSeconds

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

Type: Integer

Required: No

CachingEnabled

Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

Type: Boolean

Required: No

DataTraceEnabled

Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

Type: Boolean

Required: No

HttpMethod

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

Type: String

Pattern: .*\S.*

Required: No

LoggingLevel

The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

Type: String

Pattern: .*\S.*

Required: No

MetricsEnabled

Indicates whether CloudWatch metrics are enabled for the method.

Type: Boolean

Required: No

RequireAuthorizationForCacheControl

Indicates whether authorization is required for a cache invalidation request.

Type: Boolean

Required: No

ResourcePath

The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.

For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.

To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

Type: String

Pattern: .*\S.*

Required: No

ThrottlingBurstLimit

The throttling burst limit for the method.

Type: Integer

Required: No

ThrottlingRateLimit

The throttling rate limit for the method.

Type: Double

Required: No

UnauthorizedCacheControlHeaderStrategy

Indicates how to handle unauthorized requests for cache invalidation.

Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

Type: String

Pattern: .*\S.*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: