software.amazon.awscdk.services.apigatewayv2

Interface CfnApiGatewayManagedOverrides.StageOverridesProperty

All Known Implementing Classes:

CfnApiGatewayManagedOverrides.StageOverridesProperty.Jsii$Proxy

Enclosing class:

CfnApiGatewayManagedOverrides

public static interface CfnApiGatewayManagedOverrides.StageOverridesProperty

The `StageOverrides` property overrides the stage configuration for an API Gateway-managed stage.

If you remove this property, API Gateway restores the default values.

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.*;
 Object routeSettings;
 Object stageVariables;
 StageOverridesProperty stageOverridesProperty = StageOverridesProperty.builder()
         .accessLogSettings(AccessLogSettingsProperty.builder()
                 .destinationArn("destinationArn")
                 .format("format")
                 .build())
         .autoDeploy(false)
         .defaultRouteSettings(RouteSettingsProperty.builder()
                 .dataTraceEnabled(false)
                 .detailedMetricsEnabled(false)
                 .loggingLevel("loggingLevel")
                 .throttlingBurstLimit(123)
                 .throttlingRateLimit(123)
                 .build())
         .description("description")
         .routeSettings(routeSettings)
         .stageVariables(stageVariables)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnApiGatewayManagedOverrides.StageOverridesProperty.Builder A builder for CfnApiGatewayManagedOverrides.StageOverridesProperty
static class	CfnApiGatewayManagedOverrides.StageOverridesProperty.Jsii$Proxy An implementation for CfnApiGatewayManagedOverrides.StageOverridesProperty

Method Summary

Modifier and Type	Method and Description
static CfnApiGatewayManagedOverrides.StageOverridesProperty.Builder	builder()
default java.lang.Object	getAccessLogSettings() Settings for logging access in a stage.
default java.lang.Object	getAutoDeploy() Specifies whether updates to an API automatically trigger a new deployment.
default java.lang.Object	getDefaultRouteSettings() The default route settings for the stage.
default java.lang.String	getDescription() The description for the API stage.
default java.lang.Object	getRouteSettings() Route settings for the stage.
default java.lang.Object	getStageVariables() A map that defines the stage variables for a `Stage` .

Method Detail

getAccessLogSettings

default java.lang.Object getAccessLogSettings()

Settings for logging access in a stage.

getAutoDeploy

default java.lang.Object getAutoDeploy()

Specifies whether updates to an API automatically trigger a new deployment.

The default value is true .

getDefaultRouteSettings

default java.lang.Object getDefaultRouteSettings()

The default route settings for the stage.

getDescription

default java.lang.String getDescription()

The description for the API stage.

getRouteSettings

default java.lang.Object getRouteSettings()

Route settings for the stage.

getStageVariables

default java.lang.Object getStageVariables()

A map that defines the stage variables for a `Stage` .

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

builder

static CfnApiGatewayManagedOverrides.StageOverridesProperty.Builder builder()

Returns:

a CfnApiGatewayManagedOverrides.StageOverridesProperty.Builder of CfnApiGatewayManagedOverrides.StageOverridesProperty