Builder

class Builder

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Link copied to clipboard

A unique identifier for the fleet that is associated with this scaling policy.

Link copied to clipboard

The fleet location.

Link copied to clipboard

Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift Servers with Amazon CloudWatch.

Link copied to clipboard
var name: String?

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The type of adjustment to make to a fleet's instance count.

Link copied to clipboard

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. If the policy is suspended for a fleet, the policy status does not change.

Link copied to clipboard

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

Link copied to clipboard

Metric value used to trigger a scaling event.

Link copied to clipboard

The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

Functions