Interface CfnApiGatewayManagedOverrides.IStageOverridesProperty

The StageOverrides property overrides the stage configuration for an API Gateway-managed stage.

Namespace: Amazon.CDK.AWS.APIGatewayv2

Assembly: Amazon.CDK.AWS.APIGatewayv2.dll

Syntax (csharp)

public interface IStageOverridesProperty

Syntax (vb)

Public Interface IStageOverridesProperty

Remarks

If you remove this property, API Gateway restores the default values.

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

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

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 `Stage` .

Properties

AccessLogSettings

Settings for logging access in a stage.

virtual object AccessLogSettings { get; }

Property Value

System.Object

Remarks

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

AutoDeploy

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

virtual object AutoDeploy { get; }

Property Value

System.Object

Remarks

The default value is true .

DefaultRouteSettings

The default route settings for the stage.

virtual object DefaultRouteSettings { get; }

Property Value

System.Object

Remarks

Description

The description for the API stage.

virtual string Description { get; }

Property Value

System.String

Remarks

RouteSettings

Route settings for the stage.

virtual object RouteSettings { get; }

Property Value

System.Object

Remarks

StageVariables

A map that defines the stage variables for a Stage .

virtual object StageVariables { get; }

Property Value

System.Object

Remarks

Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.