[][src]Struct rusoto_gamelift::PutScalingPolicyInput

pub struct PutScalingPolicyInput {
    pub comparison_operator: Option<String>,
    pub evaluation_periods: Option<i64>,
    pub fleet_id: String,
    pub metric_name: String,
    pub name: String,
    pub policy_type: Option<String>,
    pub scaling_adjustment: Option<i64>,
    pub scaling_adjustment_type: Option<String>,
    pub target_configuration: Option<TargetConfiguration>,
    pub threshold: Option<f64>,
}

Represents the input for a request action.

Fields

comparison_operator: Option<String>

Comparison operator to use when measuring the metric against the threshold value.

evaluation_periods: Option<i64>

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

fleet_id: String

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

metric_name: String

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

  • ActivatingGameSessions -- Game sessions in the process of being created.

  • ActiveGameSessions -- Game sessions that are currently running.

  • ActiveInstances -- Fleet instances that are currently running at least one game session.

  • AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.

  • AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

  • CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.

  • IdleInstances -- Active instances that are currently hosting zero game sessions.

  • PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

  • PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.

  • QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

  • WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

name: String

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

policy_type: Option<String>

Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

scaling_adjustment: Option<i64>

Amount of adjustment to make, based on the scaling adjustment type.

scaling_adjustment_type: Option<String>

Type of adjustment to make to a fleet's instance count (see FleetCapacity):

  • ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

  • ExactCapacity -- set the instance count to the scaling adjustment value.

  • PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales the fleet down by 10%.

target_configuration: Option<TargetConfiguration>

Object that contains settings for a target-based scaling policy.

threshold: Option<f64>

Metric value used to trigger a scaling event.

Trait Implementations

impl Default for PutScalingPolicyInput[src]

impl PartialEq<PutScalingPolicyInput> for PutScalingPolicyInput[src]

impl Clone for PutScalingPolicyInput[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Debug for PutScalingPolicyInput[src]

impl Serialize for PutScalingPolicyInput[src]

Auto Trait Implementations

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Erased for T

impl<T> Same for T

type Output = T

Should always be Self