Class CfnDeploymentPropsMixin.CanarySettingProperty

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

Inheritance

object

CfnDeploymentPropsMixin.CanarySettingProperty

Implements

CfnDeploymentPropsMixin.ICanarySettingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDeploymentPropsMixin.CanarySettingProperty : CfnDeploymentPropsMixin.ICanarySettingProperty

Syntax (vb)

Public Class CfnDeploymentPropsMixin.CanarySettingProperty Implements CfnDeploymentPropsMixin.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.CfnPropertyMixins.AWS.ApiGateway;

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

Synopsis

Constructors

CanarySettingProperty()

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

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()

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

public CanarySettingProperty()

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

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

Properties

PercentTraffic

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

public double? PercentTraffic { get; set; }

Property Value

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

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

Type union: either Dictionary<string, string> or IResolvable

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

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

Type union: either bool or IResolvable

Implements

CfnDeploymentPropsMixin.ICanarySettingProperty