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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html

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
deploymentId?	string
percentTraffic?	number
stageVariableOverrides?	{ [string]: string } | IResolvable
useStageCache?	boolean | IResolvable

---

deploymentId?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-deploymentid

---

percentTraffic?

Type: number (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-percenttraffic

---

stageVariableOverrides?

Type: { [string]: string } | IResolvable (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-stagevariableoverrides

---

useStageCache?

Type: boolean | IResolvable (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-usestagecache