interface CanarySettingProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGateway.CfnStage.CanarySettingProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnStage_CanarySettingProperty |
![]() | software.amazon.awscdk.services.apigateway.CfnStage.CanarySettingProperty |
![]() | aws_cdk.aws_apigateway.CfnStage.CanarySettingProperty |
![]() | aws-cdk-lib » aws_apigateway » CfnStage » CanarySettingProperty |
Configuration settings of a canary deployment.
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.CfnStage.CanarySettingProperty = {
deploymentId: 'deploymentId',
percentTraffic: 123,
stageVariableOverrides: {
stageVariableOverridesKey: 'stageVariableOverrides',
},
useStageCache: false,
};
Properties
Name | Type | Description |
---|---|---|
deployment | string | The ID of the canary deployment. |
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. |
deploymentId?
Type:
string
(optional)
The ID of the canary deployment.
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.