Package software.amazon.awscdk.services.apigatewayv2

Interface CfnApiGatewayManagedOverrides.StageOverridesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiGatewayManagedOverrides.StageOverridesProperty.Jsii$Proxy

Enclosing class:

CfnApiGatewayManagedOverrides

@Stability(Stable)
public static interface CfnApiGatewayManagedOverrides.StageOverridesProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessLogSettings

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

Settings for logging access in a stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-accesslogsettings

getAutoDeploy

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

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

The default value is true .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-autodeploy

getDefaultRouteSettings

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

The default route settings for the stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-defaultroutesettings

getDescription

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

The description for the API stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-description

getRouteSettings

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

Route settings for the stage.

See Also:

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

getStageVariables

@Stability(Stable)
@Nullable
default 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-._~:/?#&=,]+.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-stageoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-stageoverrides-stagevariables

builder

@Stability(Stable)
static CfnApiGatewayManagedOverrides.StageOverridesProperty.Builder builder()

Returns:

a CfnApiGatewayManagedOverrides.StageOverridesProperty.Builder of CfnApiGatewayManagedOverrides.StageOverridesProperty