Class CfnDeployment.DeploymentCanarySettingsProperty
The DeploymentCanarySettings
property type specifies settings for the canary deployment.
Inheritance
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DeploymentCanarySettingsProperty : Object, CfnDeployment.IDeploymentCanarySettingsProperty
Syntax (vb)
Public Class DeploymentCanarySettingsProperty
Inherits Object
Implements CfnDeployment.IDeploymentCanarySettingsProperty
Remarks
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 deploymentCanarySettingsProperty = new DeploymentCanarySettingsProperty {
PercentTraffic = 123,
StageVariableOverrides = new Dictionary<string, string> {
{ "stageVariableOverridesKey", "stageVariableOverrides" }
},
UseStageCache = false
};
Synopsis
Constructors
DeploymentCanarySettingsProperty() |
Properties
PercentTraffic | The percentage (0.0-100.0) of traffic routed to the canary deployment. |
StageVariableOverrides | A stage variable overrides used for the canary release deployment. |
UseStageCache | A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. |
Constructors
DeploymentCanarySettingsProperty()
public DeploymentCanarySettingsProperty()
Properties
PercentTraffic
The percentage (0.0-100.0) of traffic routed to the canary deployment.
public Nullable<double> PercentTraffic { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
StageVariableOverrides
A stage variable overrides used for the canary release deployment.
public object StageVariableOverrides { get; set; }
Property Value
System.Object
Remarks
They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.
public object UseStageCache { get; set; }
Property Value
System.Object