Interface CfnDeployment.ICanarySettingProperty
The CanarySetting property type specifies settings for the canary deployment in this stage.
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICanarySettingPropertySyntax (vb)
Public Interface ICanarySettingPropertyRemarks
CanarySetting is a property of the StageDescription property type.
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.APIGateway;
var canarySettingProperty = new CanarySettingProperty {
PercentTraffic = 123,
StageVariableOverrides = new Dictionary<string, string> {
{ "stageVariableOverridesKey", "stageVariableOverrides" }
},
UseStageCache = false
};Synopsis
Properties
| PercentTraffic | The percent (0-100) of traffic diverted to a canary deployment. |
| StageVariableOverrides | Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. |
| UseStageCache | A Boolean flag to indicate whether the canary deployment uses the stage cache or not. |
Properties
PercentTraffic
The percent (0-100) of traffic diverted to a canary deployment.
virtual Nullable<double> PercentTraffic { get; }Property Value
System.Nullable<System.Double>
Remarks
StageVariableOverrides
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
virtual object StageVariableOverrides { get; }Property Value
System.Object
Remarks
These stage variables are represented as a string-to-string map between stage variable names and their values.
UseStageCache
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
virtual object UseStageCache { get; }Property Value
System.Object