Interface CfnDeployment.CanarySettingProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDeployment.CanarySettingProperty extends
The CanarySetting property type specifies settings for the canary deployment in this stage.

CanarySetting is a property of the StageDescription property type.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CanarySettingProperty canarySettingProperty = CanarySettingProperty.builder()
                 "stageVariableOverridesKey", "stageVariableOverrides"))
  • Method Details

    • getPercentTraffic

      @Stability(Stable) @Nullable default Number getPercentTraffic()
      The percent (0-100) of traffic diverted to a canary deployment.
    • getStageVariableOverrides

      @Stability(Stable) @Nullable default Object 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

      @Stability(Stable) @Nullable default Object getUseStageCache()
      A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
    • builder

      @Stability(Stable) static CfnDeployment.CanarySettingProperty.Builder builder()
      a CfnDeployment.CanarySettingProperty.Builder of CfnDeployment.CanarySettingProperty