AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Configuration settings of a canary deployment.

Inheritance Hierarchy


Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z


public class CanarySettings

The CanarySettings type exposes the following members


Public Method CanarySettings()


Public Property DeploymentId System.String

Gets and sets the property DeploymentId.

The ID of the canary deployment.

Public Property PercentTraffic System.Double

Gets and sets the property PercentTraffic.

The percent (0-100) of traffic diverted to a canary deployment.

Public Property StageVariableOverrides System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property StageVariableOverrides.

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

Public Property UseStageCache System.Boolean

Gets and sets the property UseStageCache.

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms