aws-cdk-lib.aws_apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty

interface StageOverridesProperty

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnApiGatewayManagedOverrides_StageOverridesProperty
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty
Pythonaws_cdk.aws_apigatewayv2.CfnApiGatewayManagedOverrides.StageOverridesProperty
TypeScript aws-cdk-lib » 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 { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';

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

NameTypeDescription
accessLogSettings?IResolvable | AccessLogSettingsPropertySettings for logging access in a stage.
autoDeploy?boolean | IResolvableSpecifies whether updates to an API automatically trigger a new deployment.
defaultRouteSettings?IResolvable | RouteSettingsPropertyThe default route settings for the stage.
description?stringThe description for the API stage.
routeSettings?anyRoute settings for the stage.
stageVariables?anyA 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-._~:/?#&=,]+.