aws-cdk-lib.aws_apigatewayv2.CfnApiGatewayManagedOverrides.RouteSettingsProperty

RouteSettingsProperty Struct

The RouteSettings property overrides the route settings for an API Gateway-managed route.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const routeSettingsProperty: apigatewayv2.CfnApiGatewayManagedOverrides.RouteSettingsProperty = {
  dataTraceEnabled: false,
  detailedMetricsEnabled: false,
  loggingLevel: 'loggingLevel',
  throttlingBurstLimit: 123,
  throttlingRateLimit: 123,
};

Properties

dataTraceEnabled?optionalboolean | IResolvabledata_trace_enabled?optionaltyping.Union[bool, IResolvable]dataTraceEnabled?optionalBooleanDataTraceEnabled?optionalboolDataTraceEnabled?optionalinterface{}#

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.

detailedMetricsEnabled?optionalboolean | IResolvabledetailed_metrics_enabled?optionaltyping.Union[bool, IResolvable]detailedMetricsEnabled?optionalBooleanDetailedMetricsEnabled?optionalboolDetailedMetricsEnabled?optionalinterface{}#

Specifies whether detailed metrics are enabled.

loggingLevel?optionalstringlogging_level?optionalstrloggingLevel?optionalStringLoggingLevel?optionalstringLoggingLevel?optional*string#

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.

throttlingBurstLimit?optionalnumberthrottling_burst_limit?optionalint | floatthrottlingBurstLimit?optionalNumberThrottlingBurstLimit?optionaldoubleThrottlingBurstLimit?optional*float64#

Specifies the throttling burst limit.

throttlingRateLimit?optionalnumberthrottling_rate_limit?optionalint | floatthrottlingRateLimit?optionalNumberThrottlingRateLimit?optionaldoubleThrottlingRateLimit?optional*float64#

Specifies the throttling rate limit.