You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GameLift::Types::TargetConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass TargetConfiguration data as a hash:

{
  target_value: 1.0, # required
}

Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

  • DescribeFleetCapacity

  • UpdateFleetCapacity

  • DescribeEC2InstanceLimits

  • Manage scaling policies:

    • PutScalingPolicy (auto-scaling)

    • DescribeScalingPolicies (auto-scaling)

    • DeleteScalingPolicy (auto-scaling)

  • Manage fleet actions:

    • StartFleetActions

    • StopFleetActions

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#target_value ⇒ Float

Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

Returns:

  • (Float) 


7089
7090
7091
7092
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7089

class TargetConfiguration < Struct.new(
  :target_value)
  include Aws::Structure
end