#[non_exhaustive]pub struct ScalingPolicyBuilder { /* private fields */ }Expand description
A builder for ScalingPolicy.
Implementations§
Source§impl ScalingPolicyBuilder
impl ScalingPolicyBuilder
Sourcepub fn auto_scaling_group_name(self, input: impl Into<String>) -> Self
pub fn auto_scaling_group_name(self, input: impl Into<String>) -> Self
The name of the Auto Scaling group.
Sourcepub fn set_auto_scaling_group_name(self, input: Option<String>) -> Self
pub fn set_auto_scaling_group_name(self, input: Option<String>) -> Self
The name of the Auto Scaling group.
Sourcepub fn get_auto_scaling_group_name(&self) -> &Option<String>
pub fn get_auto_scaling_group_name(&self) -> &Option<String>
The name of the Auto Scaling group.
Sourcepub fn policy_name(self, input: impl Into<String>) -> Self
pub fn policy_name(self, input: impl Into<String>) -> Self
The name of the scaling policy.
Sourcepub fn set_policy_name(self, input: Option<String>) -> Self
pub fn set_policy_name(self, input: Option<String>) -> Self
The name of the scaling policy.
Sourcepub fn get_policy_name(&self) -> &Option<String>
pub fn get_policy_name(&self) -> &Option<String>
The name of the scaling policy.
Sourcepub fn policy_arn(self, input: impl Into<String>) -> Self
pub fn policy_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the policy.
Sourcepub fn set_policy_arn(self, input: Option<String>) -> Self
pub fn set_policy_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the policy.
Sourcepub fn get_policy_arn(&self) -> &Option<String>
pub fn get_policy_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the policy.
Sourcepub fn policy_type(self, input: impl Into<String>) -> Self
pub fn policy_type(self, input: impl Into<String>) -> Self
One of the following policy types:
-
TargetTrackingScaling -
StepScaling -
SimpleScaling(default) -
PredictiveScaling
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn set_policy_type(self, input: Option<String>) -> Self
pub fn set_policy_type(self, input: Option<String>) -> Self
One of the following policy types:
-
TargetTrackingScaling -
StepScaling -
SimpleScaling(default) -
PredictiveScaling
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn get_policy_type(&self) -> &Option<String>
pub fn get_policy_type(&self) -> &Option<String>
One of the following policy types:
-
TargetTrackingScaling -
StepScaling -
SimpleScaling(default) -
PredictiveScaling
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn adjustment_type(self, input: impl Into<String>) -> Self
pub fn adjustment_type(self, input: impl Into<String>) -> Self
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Sourcepub fn set_adjustment_type(self, input: Option<String>) -> Self
pub fn set_adjustment_type(self, input: Option<String>) -> Self
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Sourcepub fn get_adjustment_type(&self) -> &Option<String>
pub fn get_adjustment_type(&self) -> &Option<String>
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Sourcepub fn min_adjustment_step(self, input: i32) -> Self
pub fn min_adjustment_step(self, input: i32) -> Self
Available for backward compatibility. Use MinAdjustmentMagnitude instead.
Sourcepub fn set_min_adjustment_step(self, input: Option<i32>) -> Self
pub fn set_min_adjustment_step(self, input: Option<i32>) -> Self
Available for backward compatibility. Use MinAdjustmentMagnitude instead.
Sourcepub fn get_min_adjustment_step(&self) -> &Option<i32>
pub fn get_min_adjustment_step(&self) -> &Option<i32>
Available for backward compatibility. Use MinAdjustmentMagnitude instead.
Sourcepub fn min_adjustment_magnitude(self, input: i32) -> Self
pub fn min_adjustment_magnitude(self, input: i32) -> Self
The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
Sourcepub fn set_min_adjustment_magnitude(self, input: Option<i32>) -> Self
pub fn set_min_adjustment_magnitude(self, input: Option<i32>) -> Self
The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
Sourcepub fn get_min_adjustment_magnitude(&self) -> &Option<i32>
pub fn get_min_adjustment_magnitude(&self) -> &Option<i32>
The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
Sourcepub fn scaling_adjustment(self, input: i32) -> Self
pub fn scaling_adjustment(self, input: i32) -> Self
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
Sourcepub fn set_scaling_adjustment(self, input: Option<i32>) -> Self
pub fn set_scaling_adjustment(self, input: Option<i32>) -> Self
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
Sourcepub fn get_scaling_adjustment(&self) -> &Option<i32>
pub fn get_scaling_adjustment(&self) -> &Option<i32>
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
Sourcepub fn cooldown(self, input: i32) -> Self
pub fn cooldown(self, input: i32) -> Self
The duration of the policy's cooldown period, in seconds.
Sourcepub fn set_cooldown(self, input: Option<i32>) -> Self
pub fn set_cooldown(self, input: Option<i32>) -> Self
The duration of the policy's cooldown period, in seconds.
Sourcepub fn get_cooldown(&self) -> &Option<i32>
pub fn get_cooldown(&self) -> &Option<i32>
The duration of the policy's cooldown period, in seconds.
Sourcepub fn step_adjustments(self, input: StepAdjustment) -> Self
pub fn step_adjustments(self, input: StepAdjustment) -> Self
Appends an item to step_adjustments.
To override the contents of this collection use set_step_adjustments.
A set of adjustments that enable you to scale based on the size of the alarm breach.
Sourcepub fn set_step_adjustments(self, input: Option<Vec<StepAdjustment>>) -> Self
pub fn set_step_adjustments(self, input: Option<Vec<StepAdjustment>>) -> Self
A set of adjustments that enable you to scale based on the size of the alarm breach.
Sourcepub fn get_step_adjustments(&self) -> &Option<Vec<StepAdjustment>>
pub fn get_step_adjustments(&self) -> &Option<Vec<StepAdjustment>>
A set of adjustments that enable you to scale based on the size of the alarm breach.
Sourcepub fn metric_aggregation_type(self, input: impl Into<String>) -> Self
pub fn metric_aggregation_type(self, input: impl Into<String>) -> Self
The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
Sourcepub fn set_metric_aggregation_type(self, input: Option<String>) -> Self
pub fn set_metric_aggregation_type(self, input: Option<String>) -> Self
The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
Sourcepub fn get_metric_aggregation_type(&self) -> &Option<String>
pub fn get_metric_aggregation_type(&self) -> &Option<String>
The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
Sourcepub fn estimated_instance_warmup(self, input: i32) -> Self
pub fn estimated_instance_warmup(self, input: i32) -> Self
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
Sourcepub fn set_estimated_instance_warmup(self, input: Option<i32>) -> Self
pub fn set_estimated_instance_warmup(self, input: Option<i32>) -> Self
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
Sourcepub fn get_estimated_instance_warmup(&self) -> &Option<i32>
pub fn get_estimated_instance_warmup(&self) -> &Option<i32>
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
Sourcepub fn alarms(self, input: Alarm) -> Self
pub fn alarms(self, input: Alarm) -> Self
Appends an item to alarms.
To override the contents of this collection use set_alarms.
The CloudWatch alarms related to the policy.
Sourcepub fn set_alarms(self, input: Option<Vec<Alarm>>) -> Self
pub fn set_alarms(self, input: Option<Vec<Alarm>>) -> Self
The CloudWatch alarms related to the policy.
Sourcepub fn get_alarms(&self) -> &Option<Vec<Alarm>>
pub fn get_alarms(&self) -> &Option<Vec<Alarm>>
The CloudWatch alarms related to the policy.
Sourcepub fn target_tracking_configuration(
self,
input: TargetTrackingConfiguration,
) -> Self
pub fn target_tracking_configuration( self, input: TargetTrackingConfiguration, ) -> Self
A target tracking scaling policy.
Sourcepub fn set_target_tracking_configuration(
self,
input: Option<TargetTrackingConfiguration>,
) -> Self
pub fn set_target_tracking_configuration( self, input: Option<TargetTrackingConfiguration>, ) -> Self
A target tracking scaling policy.
Sourcepub fn get_target_tracking_configuration(
&self,
) -> &Option<TargetTrackingConfiguration>
pub fn get_target_tracking_configuration( &self, ) -> &Option<TargetTrackingConfiguration>
A target tracking scaling policy.
Sourcepub fn enabled(self, input: bool) -> Self
pub fn enabled(self, input: bool) -> Self
Indicates whether the policy is enabled (true) or disabled (false).
Sourcepub fn set_enabled(self, input: Option<bool>) -> Self
pub fn set_enabled(self, input: Option<bool>) -> Self
Indicates whether the policy is enabled (true) or disabled (false).
Sourcepub fn get_enabled(&self) -> &Option<bool>
pub fn get_enabled(&self) -> &Option<bool>
Indicates whether the policy is enabled (true) or disabled (false).
Sourcepub fn predictive_scaling_configuration(
self,
input: PredictiveScalingConfiguration,
) -> Self
pub fn predictive_scaling_configuration( self, input: PredictiveScalingConfiguration, ) -> Self
A predictive scaling policy.
Sourcepub fn set_predictive_scaling_configuration(
self,
input: Option<PredictiveScalingConfiguration>,
) -> Self
pub fn set_predictive_scaling_configuration( self, input: Option<PredictiveScalingConfiguration>, ) -> Self
A predictive scaling policy.
Sourcepub fn get_predictive_scaling_configuration(
&self,
) -> &Option<PredictiveScalingConfiguration>
pub fn get_predictive_scaling_configuration( &self, ) -> &Option<PredictiveScalingConfiguration>
A predictive scaling policy.
Sourcepub fn build(self) -> ScalingPolicy
pub fn build(self) -> ScalingPolicy
Consumes the builder and constructs a ScalingPolicy.
Trait Implementations§
Source§impl Clone for ScalingPolicyBuilder
impl Clone for ScalingPolicyBuilder
Source§fn clone(&self) -> ScalingPolicyBuilder
fn clone(&self) -> ScalingPolicyBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ScalingPolicyBuilder
impl Debug for ScalingPolicyBuilder
Source§impl Default for ScalingPolicyBuilder
impl Default for ScalingPolicyBuilder
Source§fn default() -> ScalingPolicyBuilder
fn default() -> ScalingPolicyBuilder
Source§impl PartialEq for ScalingPolicyBuilder
impl PartialEq for ScalingPolicyBuilder
impl StructuralPartialEq for ScalingPolicyBuilder
Auto Trait Implementations§
impl Freeze for ScalingPolicyBuilder
impl RefUnwindSafe for ScalingPolicyBuilder
impl Send for ScalingPolicyBuilder
impl Sync for ScalingPolicyBuilder
impl Unpin for ScalingPolicyBuilder
impl UnwindSafe for ScalingPolicyBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);