Struct CanarySettings 

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

Configuration settings of 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 percent (0-100) of traffic diverted to a canary deployment.

deployment_id: Option<String>

The ID of the canary deployment.

stage_variable_overrides: Option<HashMap<String, String>>

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.

use_stage_cache: bool

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

Implementations

impl CanarySettings

pub fn percent_traffic(&self) -> f64

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

pub fn deployment_id(&self) -> Option<&str>

The ID of the canary deployment.

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

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.

pub fn use_stage_cache(&self) -> bool

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

impl CanarySettings

pub fn builder() -> CanarySettingsBuilder

Creates a new builder-style object to manufacture CanarySettings.

Trait Implementations

impl Clone for CanarySettings

fn clone(&self) -> CanarySettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanarySettings

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

Formats the value using the given formatter.

impl PartialEq for CanarySettings

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

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

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 CanarySettings