AWS CloudFormation
User Guide (API Version 2010-05-15)

RouteSettings

The RouteSettings property type is a mapping of RouteId to RouteSettings that specifies route settings for an API Gateway stage.

RouteSettings is a property of the AWS::ApiGatewayV2::Stage resource.

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: DEBUG, INFO, or WARN. 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

On this page: