Interface CfnDeployment.IDeploymentCanarySettingsProperty
- Namespace
- Amazon.CDK.AWS.APIGateway
- Assembly
- Amazon.CDK.AWS.APIGateway.dll
The DeploymentCanarySettings
property type specifies settings for the canary deployment.
public interface CfnDeployment.IDeploymentCanarySettingsProperty
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
};
Remarks
ExampleMetadata: fixture=_generated
Properties
PercentTraffic
The percentage (0.0-100.0) of traffic routed to the canary deployment.
double? PercentTraffic { get; }
Property Value
Remarks
StageVariableOverrides
A stage variable overrides used for the canary release deployment.
object? StageVariableOverrides { get; }
Property Value
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.
object? UseStageCache { get; }