aws-cdk-lib.aws_apigatewayv2.CfnStage.RouteSettingsProperty

interface RouteSettingsProperty

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnStage.RouteSettingsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnStage_RouteSettingsProperty
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnStage.RouteSettingsProperty
Pythonaws_cdk.aws_apigatewayv2.CfnStage.RouteSettingsProperty
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnStage » RouteSettingsProperty

Represents a collection of route settings.

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.CfnStage.RouteSettingsProperty = {
  dataTraceEnabled: false,
  detailedMetricsEnabled: false,
  loggingLevel: 'loggingLevel',
  throttlingBurstLimit: 123,
  throttlingRateLimit: 123,
};

Properties

NameTypeDescription
dataTraceEnabled?boolean | IResolvableSpecifies whether ( true ) or not ( false ) data trace logging is enabled for this route.
detailedMetricsEnabled?boolean | IResolvableSpecifies whether detailed metrics are enabled.
loggingLevel?stringSpecifies the logging level for this route: INFO , ERROR , or OFF .
throttlingBurstLimit?numberSpecifies the throttling burst limit.
throttlingRateLimit?numberSpecifies the throttling rate limit.

dataTraceEnabled?

Type: boolean | IResolvable (optional)

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?

Type: boolean | IResolvable (optional)

Specifies whether detailed metrics are enabled.


loggingLevel?

Type: string (optional)

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?

Type: number (optional)

Specifies the throttling burst limit.


throttlingRateLimit?

Type: number (optional)

Specifies the throttling rate limit.