MethodSetting ¶

class MethodSetting(TypedDict, closed=True):
    metrics_enabled: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether Amazon CloudWatch metrics are enabled for this method.</p>"""
    logging_level: NotRequired["capo_api_gateway.types.string.String"]
    """<p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>. Choose <code>ERROR</code> to write only error-level entries to CloudWatch Logs, or choose <code>INFO</code> to include all <code>ERROR</code> events as well as extra informational events.</p>"""
    data_trace_enabled: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether data trace logging is enabled 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.</p>"""
    throttling_burst_limit: "capo_api_gateway.types.integer.Integer"
    """<p>Specifies the throttling burst limit.</p>"""
    throttling_rate_limit: "capo_api_gateway.types.double.Double"
    """<p>Specifies the throttling rate limit.</p>"""
    caching_enabled: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.</p>"""
    cache_ttl_in_seconds: "capo_api_gateway.types.integer.Integer"
    """<p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.</p>"""
    cache_data_encrypted: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether the cached responses are encrypted.</p>"""
    require_authorization_for_cache_control: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether authorization is required for a cache invalidation request.</p>"""
    unauthorized_cache_control_header_strategy: NotRequired[
        "capo_api_gateway.types.unauthorized_cache_control_header_strategy.UnauthorizedCacheControlHeaderStrategy"
    ]
    """<p>Specifies how to handle unauthorized requests for cache invalidation.</p>"""