interface CanarySettingProperty

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	`Amazon.CDK.AWS.SAM.CfnApi.CanarySettingProperty`
Java	`software.amazon.awscdk.services.sam.CfnApi.CanarySettingProperty`
Python	`aws_cdk.aws_sam.CfnApi.CanarySettingProperty`
TypeScript	`@aws-cdk/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 * as sam from '@aws-cdk/aws-sam';
const canarySettingProperty: sam.CfnApi.CanarySettingProperty = {
  deploymentId: 'deploymentId',
  percentTraffic: 123,
  stageVariableOverrides: {
    stageVariableOverridesKey: 'stageVariableOverrides',
  },
  useStageCache: false,
};

Properties

Name	Type	Description
deploymentId?	`string`	`CfnApi.CanarySettingProperty.DeploymentId`.
percentTraffic?	`number`	`CfnApi.CanarySettingProperty.PercentTraffic`.
stageVariableOverrides?	`IResolvable` `\| { [string]: string }`	`CfnApi.CanarySettingProperty.StageVariableOverrides`.
useStageCache?	`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.