This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
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" :Number}
YAML
DataTraceEnabled:BooleanDetailedMetricsEnabled:BooleanLoggingLevel:StringThrottlingBurstLimit:IntegerThrottlingRateLimit:Number
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. Supported only for WebSocket APIs.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, orOFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.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: Number
Update requires: No interruption
See also
-
Stages in the Amazon API Gateway Version 2 API Reference
