AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::ApiGatewayV2::Stage RouteSettings

Represents a collection of route settings.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "DataTraceEnabled" : Boolean, "DetailedMetricsEnabled" : Boolean, "LoggingLevel" : String, "ThrottlingBurstLimit" : Integer, "ThrottlingRateLimit" : Double }

Properties

DataTraceEnabled

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.

Required: No

Type: Boolean

Update requires: No interruption

DetailedMetricsEnabled

Specifies whether detailed metrics are enabled.

Required: No

Type: Boolean

Update requires: No interruption

LoggingLevel

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

Required: No

Type: String

Update requires: No interruption

ThrottlingBurstLimit

Specifies the throttling burst limit.

Required: No

Type: Integer

Update requires: No interruption

ThrottlingRateLimit

Specifies the throttling rate limit.

Required: No

Type: Double

Update requires: No interruption

See Also

  • Stages in the Amazon API Gateway Version 2 API Reference

On this page: