aws-cdk-lib.aws_sam.CfnApi.CanarySettingProperty

interface CanarySettingProperty

LanguageType name
.NETAmazon.CDK.AWS.SAM.CfnApi.CanarySettingProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnApi_CanarySettingProperty
Javasoftware.amazon.awscdk.services.sam.CfnApi.CanarySettingProperty
Pythonaws_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

NameTypeDescription
deploymentId?stringCfnApi.CanarySettingProperty.DeploymentId.
percentTraffic?numberCfnApi.CanarySettingProperty.PercentTraffic.
stageVariableOverrides?IResolvable | { [string]: string }CfnApi.CanarySettingProperty.StageVariableOverrides.
useStageCache?boolean | IResolvableCfnApi.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.