Interface CfnDeployment.DeploymentCanarySettingsProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDeployment.DeploymentCanarySettingsProperty extends
The DeploymentCanarySettings property type specifies settings for the canary deployment.


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

    • getPercentTraffic

      @Stability(Stable) @Nullable default Number getPercentTraffic()
      The percentage (0.0-100.0) of traffic routed to the canary deployment.
    • getStageVariableOverrides

      @Stability(Stable) @Nullable default Object getStageVariableOverrides()
      A stage variable overrides used for the canary release deployment.

      They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.
    • builder

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