Class CfnApiGatewayManagedOverrides.StageOverridesProperty
The StageOverrides
property overrides the stage configuration for an API Gateway-managed stage.
Inheritance
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class StageOverridesProperty : Object, CfnApiGatewayManagedOverrides.IStageOverridesProperty
Syntax (vb)
Public Class StageOverridesProperty
Inherits Object
Implements CfnApiGatewayManagedOverrides.IStageOverridesProperty
Remarks
If you remove this property, API Gateway restores the default values.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
var routeSettings;
var stageVariables;
var stageOverridesProperty = new StageOverridesProperty {
AccessLogSettings = new AccessLogSettingsProperty {
DestinationArn = "destinationArn",
Format = "format"
},
AutoDeploy = false,
DefaultRouteSettings = new RouteSettingsProperty {
DataTraceEnabled = false,
DetailedMetricsEnabled = false,
LoggingLevel = "loggingLevel",
ThrottlingBurstLimit = 123,
ThrottlingRateLimit = 123
},
Description = "description",
RouteSettings = routeSettings,
StageVariables = stageVariables
};
Synopsis
Constructors
StageOverridesProperty() |
Properties
AccessLogSettings | Settings for logging access in a stage. |
AutoDeploy | Specifies whether updates to an API automatically trigger a new deployment. |
DefaultRouteSettings | The default route settings for the stage. |
Description | The description for the API stage. |
RouteSettings | Route settings for the stage. |
StageVariables | A map that defines the stage variables for a |
Constructors
StageOverridesProperty()
public StageOverridesProperty()
Properties
AccessLogSettings
Settings for logging access in a stage.
public object AccessLogSettings { get; set; }
Property Value
System.Object
Remarks
AutoDeploy
Specifies whether updates to an API automatically trigger a new deployment.
public object AutoDeploy { get; set; }
Property Value
System.Object
Remarks
DefaultRouteSettings
The default route settings for the stage.
public object DefaultRouteSettings { get; set; }
Property Value
System.Object
Remarks
Description
The description for the API stage.
public string Description { get; set; }
Property Value
System.String
Remarks
RouteSettings
Route settings for the stage.
public object RouteSettings { get; set; }
Property Value
System.Object
Remarks
StageVariables
A map that defines the stage variables for a Stage
.
public object StageVariables { get; set; }
Property Value
System.Object
Remarks
Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.