interface CanarySettingProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.SAM.CfnApi.CanarySettingProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnApi_CanarySettingProperty |
 Java | software.amazon.awscdk.services.sam.CfnApi.CanarySettingProperty |
 Python | aws_cdk.aws_sam.CfnApi.CanarySettingProperty |
 TypeScript | aws-cdk-lib » aws_sam » CfnApi » CanarySettingProperty |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';
const canarySettingProperty: sam.CfnApi.CanarySettingProperty = {
deploymentId: 'deploymentId',
percentTraffic: 123,
stageVariableOverrides: {
stageVariableOverridesKey: 'stageVariableOverrides',
},
useStageCache: false,
};
Properties
| Name | Type | Description |
|---|---|---|
| deployment | string | |
| percent | number | |
| stage | { [string]: string } | IResolvable | |
| use | boolean | IResolvable |
deploymentId?
Type:
string
(optional)
percentTraffic?
Type:
number
(optional)
stageVariableOverrides?
Type:
{ [string]: string } | IResolvable
(optional)
useStageCache?
Type:
boolean | IResolvable
(optional)