Skip to content

RouteSettings

Source code in docs_src/capo_apigatewayv2/types/route_settings.py
class RouteSettings(TypedDict, closed=True):
    data_trace_enabled: NotRequired["capo_apigatewayv2.types.__boolean.__boolean"]
    """<p>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>"""
    detailed_metrics_enabled: NotRequired["capo_apigatewayv2.types.__boolean.__boolean"]
    """<p>Specifies whether detailed metrics are enabled.</p>"""
    logging_level: NotRequired["capo_apigatewayv2.types.logging_level.LoggingLevel"]
    """<p>Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>"""
    throttling_burst_limit: NotRequired["capo_apigatewayv2.types.__integer.__integer"]
    """<p>Specifies the throttling burst limit.</p>"""
    throttling_rate_limit: NotRequired["capo_apigatewayv2.types.__double.__double"]
    """<p>Specifies the throttling rate limit.</p>"""

data_trace_enabled instance-attribute

data_trace_enabled: NotRequired[__boolean]

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

detailed_metrics_enabled instance-attribute

detailed_metrics_enabled: NotRequired[__boolean]

Specifies whether detailed metrics are enabled.

logging_level instance-attribute

logging_level: NotRequired[LoggingLevel]

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

throttling_burst_limit instance-attribute

throttling_burst_limit: NotRequired[__integer]

Specifies the throttling burst limit.

throttling_rate_limit instance-attribute

throttling_rate_limit: NotRequired[__double]

Specifies the throttling rate limit.