aws-cdk-lib.aws_sam.CfnApi.CanarySettingProperty
interface CanarySettingProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SAM.CfnApi.CanarySettingProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnApi_CanarySettingProperty |
![]() | software.amazon.awscdk.services.sam.CfnApi.CanarySettingProperty |
![]() | aws_cdk.aws_sam.CfnApi.CanarySettingProperty |
![]() | 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 | CfnApi.CanarySettingProperty.DeploymentId . |
percent | number | CfnApi.CanarySettingProperty.PercentTraffic . |
stage | IResolvable | { [string]: string } | CfnApi.CanarySettingProperty.StageVariableOverrides . |
use | boolean | IResolvable | CfnApi.CanarySettingProperty.UseStageCache . |
deploymentId?
Type:
string
(optional)
CfnApi.CanarySettingProperty.DeploymentId
.
percentTraffic?
Type:
number
(optional)
CfnApi.CanarySettingProperty.PercentTraffic
.
stageVariableOverrides?
Type:
IResolvable
| { [string]: string }
(optional)
CfnApi.CanarySettingProperty.StageVariableOverrides
.
useStageCache?
Type:
boolean |
IResolvable
(optional)
CfnApi.CanarySettingProperty.UseStageCache
.