Package software.amazon.awscdk.services.apigatewayv2

Interface CfnStage.RouteSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStage.RouteSettingsProperty.Jsii$Proxy

Enclosing class:

CfnStage

@Stability(Stable)
public static interface CfnStage.RouteSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.apigatewayv2.*;
 RouteSettingsProperty routeSettingsProperty = RouteSettingsProperty.builder()
         .dataTraceEnabled(false)
         .detailedMetricsEnabled(false)
         .loggingLevel("loggingLevel")
         .throttlingBurstLimit(123)
         .throttlingRateLimit(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStage.RouteSettingsProperty.Builder	A builder for CfnStage.RouteSettingsProperty
static final class	CfnStage.RouteSettingsProperty.Jsii$Proxy	An implementation for CfnStage.RouteSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnStage.RouteSettingsProperty.Builder	builder()
default Object	getDataTraceEnabled()	Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route.
default Object	getDetailedMetricsEnabled()	Specifies whether detailed metrics are enabled.
default String	getLoggingLevel()	Specifies the logging level for this route: INFO , ERROR , or OFF .
default Number	getThrottlingBurstLimit()	Specifies the throttling burst limit.
default Number	getThrottlingRateLimit()	Specifies the throttling rate limit.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataTraceEnabled

@Stability(Stable)
@Nullable
default Object getDataTraceEnabled()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-datatraceenabled

getDetailedMetricsEnabled

@Stability(Stable)
@Nullable
default Object getDetailedMetricsEnabled()

Specifies whether detailed metrics are enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-detailedmetricsenabled

getLoggingLevel

@Stability(Stable)
@Nullable
default String getLoggingLevel()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-logginglevel

getThrottlingBurstLimit

@Stability(Stable)
@Nullable
default Number getThrottlingBurstLimit()

Specifies the throttling burst limit.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingburstlimit

getThrottlingRateLimit

@Stability(Stable)
@Nullable
default Number getThrottlingRateLimit()

Specifies the throttling rate limit.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingratelimit

builder

@Stability(Stable)
static CfnStage.RouteSettingsProperty.Builder builder()

Returns:

a CfnStage.RouteSettingsProperty.Builder of CfnStage.RouteSettingsProperty