interface StageOverridesProperty

Language	Type name
.NET	`Amazon.CDK.AWS.APIGatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty`
Java	`software.amazon.awscdk.services.apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty`
Python	`aws_cdk.aws_apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty`
TypeScript	`@aws-cdk/aws-apigatewayv2` » `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 * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';

declare const routeSettings: any;
declare const stageVariables: any;
const stageOverridesProperty: apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty = {
  accessLogSettings: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  autoDeploy: false,
  defaultRouteSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  description: 'description',
  routeSettings: routeSettings,
  stageVariables: stageVariables,
};

Properties

Name	Type	Description
accessLogSettings?	`IResolvable` `\|` `AccessLogSettingsProperty`	Settings for logging access in a stage.
autoDeploy?	`boolean \|` `IResolvable`	Specifies whether updates to an API automatically trigger a new deployment.
defaultRouteSettings?	`IResolvable` `\|` `RouteSettingsProperty`	The default route settings for the stage.
description?	`string`	The description for the API stage.
routeSettings?	`any`	Route settings for the stage.
stageVariables?	`any`	A map that defines the stage variables for a `Stage` .

accessLogSettings?

Type: IResolvable | AccessLogSettingsProperty (optional)

Settings for logging access in a stage.

autoDeploy?

Type: boolean | IResolvable (optional)

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

The default value is true .

defaultRouteSettings?

Type: IResolvable | RouteSettingsProperty (optional)

The default route settings for the stage.

description?

Type: string (optional)

The description for the API stage.

routeSettings?

Type: any (optional)

Route settings for the stage.

stageVariables?

Type: any (optional)

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-._~:/?#&=,]+.