MethodSetting

import type { MethodSetting } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";

Specifies the method setting properties.

interface MethodSetting {

cacheDataEncrypted?: boolean | null;

cacheTtlInSeconds?: number | null;

cachingEnabled?: boolean | null;

dataTraceEnabled?: boolean | null;

loggingLevel?: string | null;

metricsEnabled?: boolean | null;

requireAuthorizationForCacheControl?: boolean | null;

throttlingBurstLimit?: number | null;

throttlingRateLimit?: number | null;

unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy | null;

}

§Properties

cacheDataEncrypted?: boolean | null

[src]

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

cacheTtlInSeconds?: number | null

[src]

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

cachingEnabled?: boolean | null

[src]

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

dataTraceEnabled?: boolean | null

[src]

Specifies whether full requests and responses are logged for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

loggingLevel?: string | null

[src]

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

metricsEnabled?: boolean | null

[src]

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

requireAuthorizationForCacheControl?: boolean | null

[src]

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

throttlingBurstLimit?: number | null

[src]

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

throttlingRateLimit?: number | null

[src]

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy | null

[src]

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.