Interface CfnStagePropsMixin.ICanarySettingProperty

Configuration settings of a canary deployment.

Namespace: Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnStagePropsMixin.ICanarySettingProperty

Syntax (vb)

Public Interface CfnStagePropsMixin.ICanarySettingProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html

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.Mixins.Preview.AWS.ApiGateway.Mixins;

             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.