NAME

Paws::GameLift::PutScalingPolicy - Arguments for method PutScalingPolicy on Paws::GameLift

DESCRIPTION

This class represents the parameters used for calling the method PutScalingPolicy on the Amazon GameLift service. Use the attributes of this class as arguments to method PutScalingPolicy.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutScalingPolicy.

SYNOPSIS

    my $gamelift = Paws->service('GameLift');
    my $PutScalingPolicyOutput = $gamelift->PutScalingPolicy(
      FleetId               => 'MyFleetIdOrArn',
      MetricName            => 'ActivatingGameSessions',
      Name                  => 'MyNonZeroAndMaxString',
      ComparisonOperator    => 'GreaterThanOrEqualToThreshold',    # OPTIONAL
      EvaluationPeriods     => 1,                                  # OPTIONAL
      PolicyType            => 'RuleBased',                        # OPTIONAL
      ScalingAdjustment     => 1,                                  # OPTIONAL
      ScalingAdjustmentType => 'ChangeInCapacity',                 # OPTIONAL
      TargetConfiguration   => {
        TargetValue => 1,
      },                                                           # OPTIONAL
      Threshold => 1,                                              # OPTIONAL
    );
    # Results:
    my $Name = $PutScalingPolicyOutput->Name;
    # Returns a L<Paws::GameLift::PutScalingPolicyOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/gamelift/PutScalingPolicy>

ATTRIBUTES

ComparisonOperator => Str

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

Valid values are: "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"

EvaluationPeriods => Int

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

REQUIRED FleetId => 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.

REQUIRED MetricName => Str

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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html).

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.

Valid values are: "ActivatingGameSessions", "ActiveGameSessions", "ActiveInstances", "AvailableGameSessions", "AvailablePlayerSessions", "CurrentPlayerSessions", "IdleInstances", "PercentAvailableGameSessions", "PercentIdleInstances", "QueueDepth", "WaitTime"

REQUIRED Name => 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.

PolicyType => Str

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.

Valid values are: "RuleBased", "TargetBased"

ScalingAdjustment => Int

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

ScalingAdjustmentType => Str

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

Valid values are: "ChangeInCapacity", "ExactCapacity", "PercentChangeInCapacity"

TargetConfiguration => Paws::GameLift::TargetConfiguration

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

Threshold => Num

Metric value used to trigger a scaling event.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>