You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::RouteSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RouteSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  data_trace_enabled: false,
  detailed_metrics_enabled: false,
  logging_level: "ERROR", # accepts ERROR, INFO, OFF
  throttling_burst_limit: 1,
  throttling_rate_limit: 1.0,
}

Represents a collection of route settings.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#data_trace_enabled ⇒ 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.

Returns:

  • (Boolean) —

    Specifies whether (true) or not (false) data trace logging is enabled for this route.

#detailed_metrics_enabled ⇒ Boolean

Specifies whether detailed metrics are enabled.

Returns:

  • (Boolean) —

    Specifies whether detailed metrics are enabled.

#logging_level ⇒ String

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.

Possible values:

  • ERROR
  • INFO
  • OFF

Returns:

  • (String) —

    Specifies the logging level for this route: INFO, ERROR, or OFF.

#throttling_burst_limit ⇒ Integer

Specifies the throttling burst limit.

Returns:

  • (Integer) —

    Specifies the throttling burst limit.

#throttling_rate_limit ⇒ Float

Specifies the throttling rate limit.

Returns:

  • (Float) —

    Specifies the throttling rate limit.