Struct AwsApiGatewayCanarySettings

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

Contains information about settings for canary deployment in the stage.

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: Option<f64>

The percentage of traffic that is diverted to a canary deployment.

deployment_id: Option<String>

The deployment identifier for the canary deployment.

stage_variable_overrides: Option<HashMap<String, String>>

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

use_stage_cache: Option<bool>

Indicates whether the canary deployment uses the stage cache.

Implementations

impl AwsApiGatewayCanarySettings

pub fn percent_traffic(&self) -> Option<f64>

The percentage of traffic that is diverted to a canary deployment.

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

The deployment identifier for the canary deployment.

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

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

pub fn use_stage_cache(&self) -> Option<bool>

Indicates whether the canary deployment uses the stage cache.

impl AwsApiGatewayCanarySettings

pub fn builder() -> AwsApiGatewayCanarySettingsBuilder

Creates a new builder-style object to manufacture AwsApiGatewayCanarySettings.

Trait Implementations

impl Clone for AwsApiGatewayCanarySettings

fn clone(&self) -> AwsApiGatewayCanarySettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AwsApiGatewayCanarySettings

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

Formats the value using the given formatter.

impl PartialEq for AwsApiGatewayCanarySettings

fn eq(&self, other: &AwsApiGatewayCanarySettings) -> 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 AwsApiGatewayCanarySettings