AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon API Gateway Resource Types Reference » AWS::ApiGateway::Deployment » Amazon API Gateway Deployment DeploymentCanarySettings

Filter View: All JSON YAML

Amazon API Gateway Deployment DeploymentCanarySettings

The DeploymentCanarySettings property type specifies settings for the canary deployment.

DeploymentCanarySettings is a property of the AWS::ApiGateway::Deployment resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "PercentTraffic" : Double ,
  "StageVariableOverrides" : { String:String, ... },
  "UseStageCache" : Boolean
}

YAML

PercentTraffic: Double
StageVariableOverrides: String: String
UseStageCache: Boolean

Properties

PercentTraffic

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

Required: No

Type: Double

Update requires: Replacement

StageVariableOverrides

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.

Duplicates are not allowed.

Required: No

Type: String to String map

Update requires: Replacement

UseStageCache

Whether the canary deployment uses the stage cache or not.

Required: No

Type: Boolean

Update requires: Replacement

See Also

• Deployment in the API Gateway API Reference