Interface CfnStage.ICanarySettingProperty
Configuration settings of a canary deployment.
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public interface ICanarySettingProperty
Syntax (vb)
Public Interface ICanarySettingProperty
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 canarySettingProperty = new CanarySettingProperty {
DeploymentId = "deploymentId",
PercentTraffic = 123,
StageVariableOverrides = new Dictionary<string, string> {
{ "stageVariableOverridesKey", "stageVariableOverrides" }
},
UseStageCache = false
};
Synopsis
Properties
DeploymentId | The ID of the canary deployment. |
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
DeploymentId
The ID of the canary deployment.
virtual string DeploymentId { get; }
Property Value
System.String
Remarks
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