AWS::ApiGatewayV2::ApiGatewayManagedOverrides StageOverrides

The StageOverrides property overrides the stage configuration for an API Gateway-managed stage. If you remove this property, API Gateway restores the default values.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AccessLogSettings" : AccessLogSettings,
  "AutoDeploy" : Boolean,
  "DefaultRouteSettings" : RouteSettings,
  "Description" : String,
  "RouteSettings" : Json,
  "StageVariables" : Json
}

YAML

  AccessLogSettings: 
    AccessLogSettings
  AutoDeploy: Boolean
  DefaultRouteSettings: 
    RouteSettings
  Description: String
  RouteSettings: Json
  StageVariables: Json

Properties

AccessLogSettings

Settings for logging access in a stage.

Required: No

Type: AccessLogSettings

Update requires: No interruption

AutoDeploy

Specifies whether updates to an API automatically trigger a new deployment. The default value is true.

Required: No

Type: Boolean

Update requires: No interruption

DefaultRouteSettings

The default route settings for the stage.

Required: No

Type: RouteSettings

Update requires: No interruption

Description

The description for the API stage.

Required: No

Type: String

Update requires: No interruption

RouteSettings

Route settings for the stage.

Required: No

Type: Json

Update requires: No interruption

StageVariables

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

Required: No

Type: Json

Update requires: No interruption