aws-cdk-lib.aws_apigateway.CfnDeployment.CanarySettingProperty

interface CanarySettingProperty

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnDeployment.CanarySettingProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDeployment_CanarySettingProperty
Javasoftware.amazon.awscdk.services.apigateway.CfnDeployment.CanarySettingProperty
Pythonaws_cdk.aws_apigateway.CfnDeployment.CanarySettingProperty
TypeScript aws-cdk-lib » aws_apigateway » CfnDeployment » CanarySettingProperty

The CanarySetting property type specifies settings for the canary deployment in this stage.

CanarySetting is a property of the StageDescription property type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const canarySettingProperty: apigateway.CfnDeployment.CanarySettingProperty = {
  percentTraffic: 123,
  stageVariableOverrides: {
    stageVariableOverridesKey: 'stageVariableOverrides',
  },
  useStageCache: false,
};

Properties

NameTypeDescription
percentTraffic?numberThe percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides?IResolvable | { [string]: string }Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.
useStageCache?boolean | IResolvableA Boolean flag to indicate whether the canary deployment uses the stage cache or not.

percentTraffic?

Type: number (optional)

The percent (0-100) of traffic diverted to a canary deployment.


stageVariableOverrides?

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

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.

These stage variables are represented as a string-to-string map between stage variable names and their values.


useStageCache?

Type: boolean | IResolvable (optional)

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.