Interface CfnStage.CanarySettingProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStage.CanarySettingProperty.Jsii$Proxy
- Enclosing class:
CfnStage
@Stability(Stable)
public static interface CfnStage.CanarySettingProperty
extends software.amazon.jsii.JsiiSerializable
Configuration settings of a canary deployment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigateway.*; CanarySettingProperty canarySettingProperty = CanarySettingProperty.builder() .deploymentId("deploymentId") .percentTraffic(123) .stageVariableOverrides(Map.of( "stageVariableOverridesKey", "stageVariableOverrides")) .useStageCache(false) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnStage.CanarySettingProperty
static final class
An implementation forCfnStage.CanarySettingProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The ID of the canary deployment.default Number
The percent (0-100) of traffic diverted to a canary deployment.default Object
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary.default Object
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDeploymentId
The ID of the canary deployment. -
getPercentTraffic
The percent (0-100) of traffic diverted to a canary deployment. -
getStageVariableOverrides
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.
-
getUseStageCache
A Boolean flag to indicate whether the canary deployment uses the stage cache or not. -
builder
-