Class CfnDeployment.CanarySettingProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

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

public class CfnDeployment.CanarySettingProperty : CfnDeployment.ICanarySettingProperty

Inheritance

object

CfnDeployment.CanarySettingProperty

Implements

CfnDeployment.ICanarySettingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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
             };

Remarks

CanarySetting is a property of the StageDescription property type.

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

ExampleMetadata: fixture=_generated

Constructors

CanarySettingProperty()

public CanarySettingProperty()

Properties

PercentTraffic

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

public double? PercentTraffic { get; set; }

Property Value

double?

Remarks

Link: 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

object

Remarks

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

Link: 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

object

Remarks

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