interface CanarySettingProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGateway.CfnDeployment.CanarySettingProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDeployment_CanarySettingProperty |
![]() | software.amazon.awscdk.services.apigateway.CfnDeployment.CanarySettingProperty |
![]() | aws_cdk.aws_apigateway.CfnDeployment.CanarySettingProperty |
![]() | aws-cdk-lib » aws_apigateway » CfnDeployment » 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 { aws_apigateway as apigateway } from 'aws-cdk-lib';
const canarySettingProperty: apigateway.CfnDeployment.CanarySettingProperty = {
percentTraffic: 123,
stageVariableOverrides: {
stageVariableOverridesKey: 'stageVariableOverrides',
},
useStageCache: false,
};
Properties
Name | Type | Description |
---|---|---|
percent | number | The percent (0-100) of traffic diverted to a canary deployment. |
stage | { [string]: string } | IResolvable | Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. |
use | 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.