interface CanarySettingProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnDeploymentPropsMixin.CanarySettingProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnDeploymentPropsMixin_CanarySettingProperty`
Java	`software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDeploymentPropsMixin.CanarySettingProperty`
Python	`aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDeploymentPropsMixin.CanarySettingProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_apigateway` » `mixins` » `CfnDeploymentPropsMixin` » `CanarySettingProperty`

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

CanarySetting is a property of the StageDescription property type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const canarySettingProperty: apigateway_mixins.CfnDeploymentPropsMixin.CanarySettingProperty = {
  percentTraffic: 123,
  stageVariableOverrides: {
    stageVariableOverridesKey: 'stageVariableOverrides',
  },
  useStageCache: false,
};

Properties

Name	Type	Description
percentTraffic?	`number`	The percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides?	`{ [string]: string } \|` `IResolvable`	Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
useStageCache?	`boolean \|` `IResolvable`	A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

percentTraffic?

Type: number (optional)

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

stageVariableOverrides?

Type: { [string]: string } | IResolvable (optional)

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

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

useStageCache?

Type: boolean | IResolvable (optional)

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

AWS CDK