AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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_enabledBoolean

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)


6219
6220
6221
6222
6223
6224
6225
6226
6227
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6219

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_enabledBoolean

Specifies whether detailed metrics are enabled.

Returns:

  • (Boolean)


6219
6220
6221
6222
6223
6224
6225
6226
6227
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6219

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

#logging_levelString

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)


6219
6220
6221
6222
6223
6224
6225
6226
6227
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6219

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_limitInteger

Specifies the throttling burst limit.

Returns:

  • (Integer)


6219
6220
6221
6222
6223
6224
6225
6226
6227
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6219

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_limitFloat

Specifies the throttling rate limit.

Returns:

  • (Float)


6219
6220
6221
6222
6223
6224
6225
6226
6227
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 6219

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