Class CfnDeployment.CanarySettingProperty

The CanarySetting property type specifies settings for the canary deployment in this stage.

Inheritance

System.Object

CfnDeployment.CanarySettingProperty

Implements

CfnDeployment.ICanarySettingProperty

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CanarySettingProperty : Object, CfnDeployment.ICanarySettingProperty

Syntax (vb)

Public Class CanarySettingProperty
    Inherits Object
    Implements CfnDeployment.ICanarySettingProperty

Remarks

CanarySetting is a property of the StageDescription property type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-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.AWS.APIGateway;

var canarySettingProperty = new CanarySettingProperty {
    PercentTraffic = 123,
    StageVariableOverrides = new Dictionary<string, string> {
        { "stageVariableOverridesKey", "stageVariableOverrides" }
    },
    UseStageCache = false
};

Synopsis

Constructors

CanarySettingProperty()

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.

Constructors

CanarySettingProperty()

public CanarySettingProperty()

Properties

PercentTraffic

The percent (0-100) of traffic diverted to a canary deployment.

public Nullable<double> PercentTraffic { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-percenttraffic

StageVariableOverrides

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.

public object StageVariableOverrides { get; set; }

Property Value

System.Object

Remarks

These stage variables are represented as a string-to-string map between stage variable names and their values.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-stagevariableoverrides

UseStageCache

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

public object UseStageCache { get; set; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-usestagecache

Implements

CfnDeployment.ICanarySettingProperty