Aws::GameLift::Model::TargetConfiguration Class Reference

#include <TargetConfiguration.h>

Public Member Functions
	TargetConfiguration ()
	TargetConfiguration (Aws::Utils::Json::JsonView jsonValue)
TargetConfiguration &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
double	GetTargetValue () const
bool	TargetValueHasBeenSet () const
void	SetTargetValue (double value)
TargetConfiguration &	WithTargetValue (double value)

Detailed Description

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.

Related actions

DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task

See Also:

AWS API Reference

Definition at line 40 of file TargetConfiguration.h.

Constructor & Destructor Documentation

TargetConfiguration() [1/2]

Aws::GameLift::Model::TargetConfiguration::TargetConfiguration

(

)

TargetConfiguration() [2/2]

Aws::GameLift::Model::TargetConfiguration::TargetConfiguration

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

GetTargetValue()

double Aws::GameLift::Model::TargetConfiguration::GetTargetValue ( ) const

inline

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

Definition at line 56 of file TargetConfiguration.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::TargetConfiguration::Jsonize

(

)

const

operator=()

TargetConfiguration& Aws::GameLift::Model::TargetConfiguration::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

SetTargetValue()

void Aws::GameLift::Model::TargetConfiguration::SetTargetValue ( double  value )

inline

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

Definition at line 74 of file TargetConfiguration.h.

TargetValueHasBeenSet()

bool Aws::GameLift::Model::TargetConfiguration::TargetValueHasBeenSet ( ) const

inline

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

Definition at line 65 of file TargetConfiguration.h.

WithTargetValue()

TargetConfiguration& Aws::GameLift::Model::TargetConfiguration::WithTargetValue ( double  value )

inline

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

Definition at line 83 of file TargetConfiguration.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-gamelift/include/aws/gamelift/model/TargetConfiguration.h