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

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, false
  throttling_burst_limit: 1,
  throttling_rate_limit: 1.0,
}

Represents a collection of route settings.

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.

Returns:

  • (Boolean)


4424
4425
4426
4427
4428
4429
4430
4431
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4424

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

#detailed_metrics_enabledBoolean

Specifies whether detailed metrics are enabled.

Returns:

  • (Boolean)


4424
4425
4426
4427
4428
4429
4430
4431
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4424

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

#logging_levelString

Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

Returns:

  • (String)


4424
4425
4426
4427
4428
4429
4430
4431
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4424

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

#throttling_burst_limitInteger

Specifies the throttling burst limit.

Returns:

  • (Integer)


4424
4425
4426
4427
4428
4429
4430
4431
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4424

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

#throttling_rate_limitFloat

Specifies the throttling rate limit.

Returns:

  • (Float)


4424
4425
4426
4427
4428
4429
4430
4431
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 4424

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