Struct rusoto_gamelift::PutScalingPolicyInput
source · [−]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>,
}
Expand description
Represents the input for a request operation.
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
A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. 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
A descriptive label that is associated with a fleet's 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>
The 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>
The 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>
An object that contains settings for a target-based scaling policy.
threshold: Option<f64>
Metric value used to trigger a scaling event.
Trait Implementations
sourceimpl Clone for PutScalingPolicyInput
impl Clone for PutScalingPolicyInput
sourcefn clone(&self) -> PutScalingPolicyInput
fn clone(&self) -> PutScalingPolicyInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PutScalingPolicyInput
impl Debug for PutScalingPolicyInput
sourceimpl Default for PutScalingPolicyInput
impl Default for PutScalingPolicyInput
sourcefn default() -> PutScalingPolicyInput
fn default() -> PutScalingPolicyInput
Returns the “default value” for a type. Read more
sourceimpl PartialEq<PutScalingPolicyInput> for PutScalingPolicyInput
impl PartialEq<PutScalingPolicyInput> for PutScalingPolicyInput
sourcefn eq(&self, other: &PutScalingPolicyInput) -> bool
fn eq(&self, other: &PutScalingPolicyInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PutScalingPolicyInput) -> bool
fn ne(&self, other: &PutScalingPolicyInput) -> bool
This method tests for !=
.
sourceimpl Serialize for PutScalingPolicyInput
impl Serialize for PutScalingPolicyInput
impl StructuralPartialEq for PutScalingPolicyInput
Auto Trait Implementations
impl RefUnwindSafe for PutScalingPolicyInput
impl Send for PutScalingPolicyInput
impl Sync for PutScalingPolicyInput
impl Unpin for PutScalingPolicyInput
impl UnwindSafe for PutScalingPolicyInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more