ScalingPolicy class

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

Constructors

ScalingPolicy({ComparisonOperatorType? comparisonOperator, int? evaluationPeriods, String? fleetId, MetricName? metricName, String? name, PolicyType? policyType, int? scalingAdjustment, ScalingAdjustmentType? scalingAdjustmentType, ScalingStatusType? status, TargetConfiguration? targetConfiguration, double? threshold})
ScalingPolicy.fromJson(Map<String, dynamic> json)
factory

Properties

comparisonOperator → ComparisonOperatorType?
Comparison operator to use when measuring a metric against the threshold value.
final
evaluationPeriods → int?
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
final
fleetId → String?
A unique identifier for a fleet that is associated with this scaling policy.
final
hashCode → int
The hash code for this object.
no setterinherited
metricName → 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.
final
name → String?
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
final
policyType → 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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scalingAdjustment → int?
Amount of adjustment to make, based on the scaling adjustment type.
final
scalingAdjustmentType → ScalingAdjustmentType?
The type of adjustment to make to a fleet's instance count (see FleetCapacity):
final
status → ScalingStatusType?
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.
final
targetConfiguration → TargetConfiguration?
The settings for a target-based scaling policy.
final
threshold → double?
Metric value used to trigger a scaling event.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited