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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Note:

When making an API call, you may pass RouteSettings data as a 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.

Constant Summary collapse

SENSITIVE = 
[]

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) 


5662
5663
5664
5665
5666
5667
5668
5669
5670
 
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5662

class RouteSettings < Struct.new(
  :data_trace_enabled,
  :detailed_metrics_enabled,
  :logging_level,
  :throttling_burst_limit,
  :throttling_rate_limit)
  SENSITIVE = []
  include Aws::Structure
end

#detailed_metrics_enabled ⇒ Boolean

Specifies whether detailed metrics are enabled.

Returns:

  • (Boolean) 


5662
5663
5664
5665
5666
5667
5668
5669
5670
 
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5662

class RouteSettings < Struct.new(
  :data_trace_enabled,
  :detailed_metrics_enabled,
  :logging_level,
  :throttling_burst_limit,
  :throttling_rate_limit)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


5662
5663
5664
5665
5666
5667
5668
5669
5670
 
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5662

class RouteSettings < Struct.new(
  :data_trace_enabled,
  :detailed_metrics_enabled,
  :logging_level,
  :throttling_burst_limit,
  :throttling_rate_limit)
  SENSITIVE = []
  include Aws::Structure
end

#throttling_burst_limit ⇒ Integer

Specifies the throttling burst limit.

Returns:

  • (Integer) 


5662
5663
5664
5665
5666
5667
5668
5669
5670
 
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5662

class RouteSettings < Struct.new(
  :data_trace_enabled,
  :detailed_metrics_enabled,
  :logging_level,
  :throttling_burst_limit,
  :throttling_rate_limit)
  SENSITIVE = []
  include Aws::Structure
end

#throttling_rate_limit ⇒ Float

Specifies the throttling rate limit.

Returns:

  • (Float) 


5662
5663
5664
5665
5666
5667
5668
5669
5670
 
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5662

class RouteSettings < Struct.new(
  :data_trace_enabled,
  :detailed_metrics_enabled,
  :logging_level,
  :throttling_burst_limit,
  :throttling_rate_limit)
  SENSITIVE = []
  include Aws::Structure
end