Struct DeploymentCanarySettings

#[non_exhaustive]
pub struct DeploymentCanarySettings {
    pub percent_traffic: f64,
    pub stage_variable_overrides: Option<HashMap<String, String>>,
    pub use_stage_cache: bool,
}

The input configuration for a canary deployment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

percent_traffic: f64

The percentage (0.0-100.0) of traffic routed to the canary deployment.

stage_variable_overrides: Option<HashMap<String, String>>

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.

use_stage_cache: bool

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

Implementations

impl DeploymentCanarySettings

pub fn percent_traffic(&self) -> f64

The percentage (0.0-100.0) of traffic routed to the canary deployment.

pub fn stage_variable_overrides(&self) -> Option<&HashMap<String, String>>

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.

pub fn use_stage_cache(&self) -> bool

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

impl DeploymentCanarySettings

pub fn builder() -> DeploymentCanarySettingsBuilder

Creates a new builder-style object to manufacture DeploymentCanarySettings.

Trait Implementations

impl Clone for DeploymentCanarySettings

fn clone(&self) -> DeploymentCanarySettings

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeploymentCanarySettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DeploymentCanarySettings

fn eq(&self, other: &DeploymentCanarySettings) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DeploymentCanarySettings