[−][src]Struct rusoto_gamelift::ScalingPolicy
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
Operations related to fleet capacity scaling include:
-
Manage scaling policies:
-
PutScalingPolicy (auto-scaling)
-
DescribeScalingPolicies (auto-scaling)
-
DeleteScalingPolicy (auto-scaling)
-
-
Manage fleet actions:
Fields
comparison_operator: Option<String>
Comparison operator to use when measuring a 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: Option<String>
Unique identifier for a fleet that is associated with this scaling policy.
metric_name: Option<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: Option<String>
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
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.
status: Option<String>
Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE
status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
-
ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
-
UPDATEREQUESTED -- A request to update the scaling policy has been received.
-
UPDATING -- A change is being made to the scaling policy.
-
DELETEREQUESTED -- A request to delete the scaling policy has been received.
-
DELETING -- The scaling policy is being deleted.
-
DELETED -- The scaling policy has been deleted.
-
ERROR -- An error occurred in creating the policy. It should be removed and recreated.
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 ScalingPolicy
[src]
impl Default for ScalingPolicy
fn default() -> ScalingPolicy
[src]
fn default() -> ScalingPolicy
Returns the "default value" for a type. Read more
impl PartialEq<ScalingPolicy> for ScalingPolicy
[src]
impl PartialEq<ScalingPolicy> for ScalingPolicy
fn eq(&self, other: &ScalingPolicy) -> bool
[src]
fn eq(&self, other: &ScalingPolicy) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &ScalingPolicy) -> bool
[src]
fn ne(&self, other: &ScalingPolicy) -> bool
This method tests for !=
.
impl Clone for ScalingPolicy
[src]
impl Clone for ScalingPolicy
fn clone(&self) -> ScalingPolicy
[src]
fn clone(&self) -> ScalingPolicy
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for ScalingPolicy
[src]
impl Debug for ScalingPolicy
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<'de> Deserialize<'de> for ScalingPolicy
[src]
impl<'de> Deserialize<'de> for ScalingPolicy
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl Send for ScalingPolicy
impl Send for ScalingPolicy
impl Sync for ScalingPolicy
impl Sync for ScalingPolicy
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
type Owned = T
fn to_owned(&self) -> T
[src]
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
[src]
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
try_from
)Performs the conversion.
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
impl<T> Same for T
impl<T> Same for T
type Output = T
Should always be Self
impl<T> Erased for T
impl<T> Erased for T