Struct aws_sdk_gamelift::input::PutScalingPolicyInput

#[non_exhaustive]
pub struct PutScalingPolicyInput {
    pub name: Option<String>,
    pub fleet_id: Option<String>,
    pub scaling_adjustment: i32,
    pub scaling_adjustment_type: Option<ScalingAdjustmentType>,
    pub threshold: f64,
    pub comparison_operator: Option<ComparisonOperatorType>,
    pub evaluation_periods: Option<i32>,
    pub metric_name: Option<MetricName>,
    pub policy_type: Option<PolicyType>,
    pub target_configuration: Option<TargetConfiguration>,
}

Represents the input for a request operation.

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.

name: Option<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.

fleet_id: Option<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.

scaling_adjustment: i32

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

scaling_adjustment_type: Option<ScalingAdjustmentType>

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%.

threshold: f64

Metric value used to trigger a scaling event.

comparison_operator: Option<ComparisonOperatorType>

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

evaluation_periods: Option<i32>

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

metric_name: Option<MetricName>

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.

policy_type: Option<PolicyType>

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.

target_configuration: Option<TargetConfiguration>

An object that contains settings for a target-based scaling policy.

Implementations

impl PutScalingPolicyInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<PutScalingPolicy, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<PutScalingPolicy>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture PutScalingPolicyInput

impl PutScalingPolicyInput

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

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.

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

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.

pub fn scaling_adjustment(&self) -> i32

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

pub fn scaling_adjustment_type(&self) -> Option<&ScalingAdjustmentType>

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%.

pub fn threshold(&self) -> f64

Metric value used to trigger a scaling event.

pub fn comparison_operator(&self) -> Option<&ComparisonOperatorType>

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

pub fn evaluation_periods(&self) -> Option<i32>

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

pub fn metric_name(&self) -> Option<&MetricName>

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.

pub fn policy_type(&self) -> Option<&PolicyType>

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.

pub fn target_configuration(&self) -> Option<&TargetConfiguration>

An object that contains settings for a target-based scaling policy.

Trait Implementations

impl Clone for PutScalingPolicyInput

fn clone(&self) -> PutScalingPolicyInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutScalingPolicyInput

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

Formats the value using the given formatter.

impl PartialEq<PutScalingPolicyInput> for PutScalingPolicyInput

fn eq(&self, other: &PutScalingPolicyInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PutScalingPolicyInput) -> bool

This method tests for !=.

impl StructuralPartialEq for PutScalingPolicyInput