Aws::GameLift::Model::ScalingPolicy Class Reference

#include <ScalingPolicy.h>

Public Member Functions
	ScalingPolicy ()
	ScalingPolicy (Aws::Utils::Json::JsonView jsonValue)
ScalingPolicy &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
const Aws::String &	GetFleetId () const
bool	FleetIdHasBeenSet () const
void	SetFleetId (const Aws::String &value)
void	SetFleetId (Aws::String &&value)
void	SetFleetId (const char *value)
ScalingPolicy &	WithFleetId (const Aws::String &value)
ScalingPolicy &	WithFleetId (Aws::String &&value)
ScalingPolicy &	WithFleetId (const char *value)
const Aws::String &	GetFleetArn () const
bool	FleetArnHasBeenSet () const
void	SetFleetArn (const Aws::String &value)
void	SetFleetArn (Aws::String &&value)
void	SetFleetArn (const char *value)
ScalingPolicy &	WithFleetArn (const Aws::String &value)
ScalingPolicy &	WithFleetArn (Aws::String &&value)
ScalingPolicy &	WithFleetArn (const char *value)
const Aws::String &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const Aws::String &value)
void	SetName (Aws::String &&value)
void	SetName (const char *value)
ScalingPolicy &	WithName (const Aws::String &value)
ScalingPolicy &	WithName (Aws::String &&value)
ScalingPolicy &	WithName (const char *value)
const ScalingStatusType &	GetStatus () const
bool	StatusHasBeenSet () const
void	SetStatus (const ScalingStatusType &value)
void	SetStatus (ScalingStatusType &&value)
ScalingPolicy &	WithStatus (const ScalingStatusType &value)
ScalingPolicy &	WithStatus (ScalingStatusType &&value)
int	GetScalingAdjustment () const
bool	ScalingAdjustmentHasBeenSet () const
void	SetScalingAdjustment (int value)
ScalingPolicy &	WithScalingAdjustment (int value)
const ScalingAdjustmentType &	GetScalingAdjustmentType () const
bool	ScalingAdjustmentTypeHasBeenSet () const
void	SetScalingAdjustmentType (const ScalingAdjustmentType &value)
void	SetScalingAdjustmentType (ScalingAdjustmentType &&value)
ScalingPolicy &	WithScalingAdjustmentType (const ScalingAdjustmentType &value)
ScalingPolicy &	WithScalingAdjustmentType (ScalingAdjustmentType &&value)
const ComparisonOperatorType &	GetComparisonOperator () const
bool	ComparisonOperatorHasBeenSet () const
void	SetComparisonOperator (const ComparisonOperatorType &value)
void	SetComparisonOperator (ComparisonOperatorType &&value)
ScalingPolicy &	WithComparisonOperator (const ComparisonOperatorType &value)
ScalingPolicy &	WithComparisonOperator (ComparisonOperatorType &&value)
double	GetThreshold () const
bool	ThresholdHasBeenSet () const
void	SetThreshold (double value)
ScalingPolicy &	WithThreshold (double value)
int	GetEvaluationPeriods () const
bool	EvaluationPeriodsHasBeenSet () const
void	SetEvaluationPeriods (int value)
ScalingPolicy &	WithEvaluationPeriods (int value)
const MetricName &	GetMetricName () const
bool	MetricNameHasBeenSet () const
void	SetMetricName (const MetricName &value)
void	SetMetricName (MetricName &&value)
ScalingPolicy &	WithMetricName (const MetricName &value)
ScalingPolicy &	WithMetricName (MetricName &&value)
const PolicyType &	GetPolicyType () const
bool	PolicyTypeHasBeenSet () const
void	SetPolicyType (const PolicyType &value)
void	SetPolicyType (PolicyType &&value)
ScalingPolicy &	WithPolicyType (const PolicyType &value)
ScalingPolicy &	WithPolicyType (PolicyType &&value)
const TargetConfiguration &	GetTargetConfiguration () const
bool	TargetConfigurationHasBeenSet () const
void	SetTargetConfiguration (const TargetConfiguration &value)
void	SetTargetConfiguration (TargetConfiguration &&value)
ScalingPolicy &	WithTargetConfiguration (const TargetConfiguration &value)
ScalingPolicy &	WithTargetConfiguration (TargetConfiguration &&value)
const LocationUpdateStatus &	GetUpdateStatus () const
bool	UpdateStatusHasBeenSet () const
void	SetUpdateStatus (const LocationUpdateStatus &value)
void	SetUpdateStatus (LocationUpdateStatus &&value)
ScalingPolicy &	WithUpdateStatus (const LocationUpdateStatus &value)
ScalingPolicy &	WithUpdateStatus (LocationUpdateStatus &&value)
const Aws::String &	GetLocation () const
bool	LocationHasBeenSet () const
void	SetLocation (const Aws::String &value)
void	SetLocation (Aws::String &&value)
void	SetLocation (const char *value)
ScalingPolicy &	WithLocation (const Aws::String &value)
ScalingPolicy &	WithLocation (Aws::String &&value)
ScalingPolicy &	WithLocation (const char *value)

Detailed Description

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

Related actions

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

See Also:

AWS API Reference

Definition at line 45 of file ScalingPolicy.h.

Constructor & Destructor Documentation

ScalingPolicy() [1/2]

Aws::GameLift::Model::ScalingPolicy::ScalingPolicy

(

)

ScalingPolicy() [2/2]

Aws::GameLift::Model::ScalingPolicy::ScalingPolicy

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

ComparisonOperatorHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::ComparisonOperatorHasBeenSet ( ) const

inline

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

Definition at line 438 of file ScalingPolicy.h.

EvaluationPeriodsHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::EvaluationPeriodsHasBeenSet ( ) const

inline

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

Definition at line 496 of file ScalingPolicy.h.

FleetArnHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::FleetArnHasBeenSet ( ) const

inline

The Amazon Resource Name (ARN) that is assigned to a GameLift 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.

Definition at line 119 of file ScalingPolicy.h.

FleetIdHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::FleetIdHasBeenSet ( ) const

inline

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

Definition at line 64 of file ScalingPolicy.h.

GetComparisonOperator()

const ComparisonOperatorType& Aws::GameLift::Model::ScalingPolicy::GetComparisonOperator ( ) const

inline

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

Definition at line 432 of file ScalingPolicy.h.

GetEvaluationPeriods()

int Aws::GameLift::Model::ScalingPolicy::GetEvaluationPeriods ( ) const

inline

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

Definition at line 490 of file ScalingPolicy.h.

GetFleetArn()

const Aws::String& Aws::GameLift::Model::ScalingPolicy::GetFleetArn ( ) const

inline

The Amazon Resource Name (ARN) that is assigned to a GameLift 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.

Definition at line 110 of file ScalingPolicy.h.

GetFleetId()

const Aws::String& Aws::GameLift::Model::ScalingPolicy::GetFleetId ( ) const

inline

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

Definition at line 58 of file ScalingPolicy.h.

GetLocation()

const Aws::String& Aws::GameLift::Model::ScalingPolicy::GetLocation ( ) const

inline

Definition at line 830 of file ScalingPolicy.h.

GetMetricName()

const MetricName& Aws::GameLift::Model::ScalingPolicy::GetMetricName ( ) const

inline

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.

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

Definition at line 539 of file ScalingPolicy.h.

GetName()

const Aws::String& Aws::GameLift::Model::ScalingPolicy::GetName ( ) const

inline

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

Definition at line 180 of file ScalingPolicy.h.

GetPolicyType()

const PolicyType& Aws::GameLift::Model::ScalingPolicy::GetPolicyType ( ) const

inline

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.

Definition at line 700 of file ScalingPolicy.h.

GetScalingAdjustment()

int Aws::GameLift::Model::ScalingPolicy::GetScalingAdjustment ( ) const

inline

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

Definition at line 337 of file ScalingPolicy.h.

GetScalingAdjustmentType()

const ScalingAdjustmentType& Aws::GameLift::Model::ScalingPolicy::GetScalingAdjustmentType ( ) const

inline

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.

Definition at line 365 of file ScalingPolicy.h.

GetStatus()

const ScalingStatusType& Aws::GameLift::Model::ScalingPolicy::GetStatus ( ) const

inline

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.

• ACTIVE – The scaling policy can be used for auto-scaling a fleet.

• UPDATE_REQUESTED – A request to update the scaling policy has been received.

• UPDATING – A change is being made to the scaling policy.

• DELETE_REQUESTED – A request to delete the scaling policy has been received.

• DELETING – The scaling policy is being deleted.

• DELETED – The scaling policy has been deleted.

• ERROR – An error occurred in creating the policy. It should be removed and recreated.

Definition at line 241 of file ScalingPolicy.h.

GetTargetConfiguration()

const TargetConfiguration& Aws::GameLift::Model::ScalingPolicy::GetTargetConfiguration ( ) const

inline

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

Definition at line 756 of file ScalingPolicy.h.

GetThreshold()

double Aws::GameLift::Model::ScalingPolicy::GetThreshold ( ) const

inline

Metric value used to trigger a scaling event.

Definition at line 468 of file ScalingPolicy.h.

GetUpdateStatus()

const LocationUpdateStatus& Aws::GameLift::Model::ScalingPolicy::GetUpdateStatus ( ) const

inline

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.

Definition at line 789 of file ScalingPolicy.h.

Jsonize()

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

(

)

const

LocationHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::LocationHasBeenSet ( ) const

inline

Definition at line 835 of file ScalingPolicy.h.

MetricNameHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::MetricNameHasBeenSet ( ) const

inline

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.

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

Definition at line 569 of file ScalingPolicy.h.

NameHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::NameHasBeenSet ( ) const

inline

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

Definition at line 186 of file ScalingPolicy.h.

operator=()

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

PolicyTypeHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::PolicyTypeHasBeenSet ( ) const

inline

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.

Definition at line 710 of file ScalingPolicy.h.

ScalingAdjustmentHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::ScalingAdjustmentHasBeenSet ( ) const

inline

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

Definition at line 342 of file ScalingPolicy.h.

ScalingAdjustmentTypeHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::ScalingAdjustmentTypeHasBeenSet ( ) const

inline

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.

Definition at line 377 of file ScalingPolicy.h.

SetComparisonOperator() [1/2]

void Aws::GameLift::Model::ScalingPolicy::SetComparisonOperator ( ComparisonOperatorType &&  value )

inline

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

Definition at line 450 of file ScalingPolicy.h.

SetComparisonOperator() [2/2]

void Aws::GameLift::Model::ScalingPolicy::SetComparisonOperator ( const ComparisonOperatorType &  value )

inline

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

Definition at line 444 of file ScalingPolicy.h.

SetEvaluationPeriods()

void Aws::GameLift::Model::ScalingPolicy::SetEvaluationPeriods ( int  value )

inline

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

Definition at line 502 of file ScalingPolicy.h.

SetFleetArn() [1/3]

void Aws::GameLift::Model::ScalingPolicy::SetFleetArn ( Aws::String &&  value )

inline

The Amazon Resource Name (ARN) that is assigned to a GameLift 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.

Definition at line 137 of file ScalingPolicy.h.

SetFleetArn() [2/3]

void Aws::GameLift::Model::ScalingPolicy::SetFleetArn ( const Aws::String &  value )

inline

The Amazon Resource Name (ARN) that is assigned to a GameLift 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.

Definition at line 128 of file ScalingPolicy.h.

SetFleetArn() [3/3]

void Aws::GameLift::Model::ScalingPolicy::SetFleetArn ( const char *  value )

inline

The Amazon Resource Name (ARN) that is assigned to a GameLift 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.

Definition at line 146 of file ScalingPolicy.h.

SetFleetId() [1/3]

void Aws::GameLift::Model::ScalingPolicy::SetFleetId ( Aws::String &&  value )

inline

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

Definition at line 76 of file ScalingPolicy.h.

SetFleetId() [2/3]

void Aws::GameLift::Model::ScalingPolicy::SetFleetId ( const Aws::String &  value )

inline

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

Definition at line 70 of file ScalingPolicy.h.

SetFleetId() [3/3]

void Aws::GameLift::Model::ScalingPolicy::SetFleetId ( const char *  value )

inline

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

Definition at line 82 of file ScalingPolicy.h.

SetLocation() [1/3]

void Aws::GameLift::Model::ScalingPolicy::SetLocation ( Aws::String &&  value )

inline

Definition at line 845 of file ScalingPolicy.h.

SetLocation() [2/3]

void Aws::GameLift::Model::ScalingPolicy::SetLocation ( const Aws::String &  value )

inline

Definition at line 840 of file ScalingPolicy.h.

SetLocation() [3/3]

void Aws::GameLift::Model::ScalingPolicy::SetLocation ( const char *  value )

inline

Definition at line 850 of file ScalingPolicy.h.

SetMetricName() [1/2]

void Aws::GameLift::Model::ScalingPolicy::SetMetricName ( const MetricName &  value )

inline

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.

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

Definition at line 599 of file ScalingPolicy.h.

SetMetricName() [2/2]

void Aws::GameLift::Model::ScalingPolicy::SetMetricName ( MetricName &&  value )

inline

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.

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

Definition at line 629 of file ScalingPolicy.h.

SetName() [1/3]

void Aws::GameLift::Model::ScalingPolicy::SetName ( Aws::String &&  value )

inline

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

Definition at line 198 of file ScalingPolicy.h.

SetName() [2/3]

void Aws::GameLift::Model::ScalingPolicy::SetName ( const Aws::String &  value )

inline

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

Definition at line 192 of file ScalingPolicy.h.

SetName() [3/3]

void Aws::GameLift::Model::ScalingPolicy::SetName ( const char *  value )

inline

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

Definition at line 204 of file ScalingPolicy.h.

SetPolicyType() [1/2]

void Aws::GameLift::Model::ScalingPolicy::SetPolicyType ( const PolicyType &  value )

inline

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.

Definition at line 720 of file ScalingPolicy.h.

SetPolicyType() [2/2]

void Aws::GameLift::Model::ScalingPolicy::SetPolicyType ( PolicyType &&  value )

inline

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.

Definition at line 730 of file ScalingPolicy.h.

SetScalingAdjustment()

void Aws::GameLift::Model::ScalingPolicy::SetScalingAdjustment ( int  value )

inline

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

Definition at line 347 of file ScalingPolicy.h.

SetScalingAdjustmentType() [1/2]

void Aws::GameLift::Model::ScalingPolicy::SetScalingAdjustmentType ( const ScalingAdjustmentType &  value )

inline

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.

Definition at line 389 of file ScalingPolicy.h.

SetScalingAdjustmentType() [2/2]

void Aws::GameLift::Model::ScalingPolicy::SetScalingAdjustmentType ( ScalingAdjustmentType &&  value )

inline

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.

Definition at line 401 of file ScalingPolicy.h.

SetStatus() [1/2]

void Aws::GameLift::Model::ScalingPolicy::SetStatus ( const ScalingStatusType &  value )

inline

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.

• ACTIVE – The scaling policy can be used for auto-scaling a fleet.

• UPDATE_REQUESTED – A request to update the scaling policy has been received.

• UPDATING – A change is being made to the scaling policy.

• DELETE_REQUESTED – A request to delete the scaling policy has been received.

• DELETING – The scaling policy is being deleted.

• DELETED – The scaling policy has been deleted.

• ERROR – An error occurred in creating the policy. It should be removed and recreated.

Definition at line 277 of file ScalingPolicy.h.

SetStatus() [2/2]

void Aws::GameLift::Model::ScalingPolicy::SetStatus ( ScalingStatusType &&  value )

inline

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.

• ACTIVE – The scaling policy can be used for auto-scaling a fleet.

• UPDATE_REQUESTED – A request to update the scaling policy has been received.

• UPDATING – A change is being made to the scaling policy.

• DELETE_REQUESTED – A request to delete the scaling policy has been received.

• DELETING – The scaling policy is being deleted.

• DELETED – The scaling policy has been deleted.

• ERROR – An error occurred in creating the policy. It should be removed and recreated.

Definition at line 295 of file ScalingPolicy.h.

SetTargetConfiguration() [1/2]

void Aws::GameLift::Model::ScalingPolicy::SetTargetConfiguration ( const TargetConfiguration &  value )

inline

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

Definition at line 766 of file ScalingPolicy.h.

SetTargetConfiguration() [2/2]

void Aws::GameLift::Model::ScalingPolicy::SetTargetConfiguration ( TargetConfiguration &&  value )

inline

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

Definition at line 771 of file ScalingPolicy.h.

SetThreshold()

void Aws::GameLift::Model::ScalingPolicy::SetThreshold ( double  value )

inline

Metric value used to trigger a scaling event.

Definition at line 478 of file ScalingPolicy.h.

SetUpdateStatus() [1/2]

void Aws::GameLift::Model::ScalingPolicy::SetUpdateStatus ( const LocationUpdateStatus &  value )

inline

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.

Definition at line 803 of file ScalingPolicy.h.

SetUpdateStatus() [2/2]

void Aws::GameLift::Model::ScalingPolicy::SetUpdateStatus ( LocationUpdateStatus &&  value )

inline

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.

Definition at line 810 of file ScalingPolicy.h.

StatusHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::StatusHasBeenSet ( ) const

inline

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.

• ACTIVE – The scaling policy can be used for auto-scaling a fleet.

• UPDATE_REQUESTED – A request to update the scaling policy has been received.

• UPDATING – A change is being made to the scaling policy.

• DELETE_REQUESTED – A request to delete the scaling policy has been received.

• DELETING – The scaling policy is being deleted.

• DELETED – The scaling policy has been deleted.

• ERROR – An error occurred in creating the policy. It should be removed and recreated.

Definition at line 259 of file ScalingPolicy.h.

TargetConfigurationHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::TargetConfigurationHasBeenSet ( ) const

inline

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

Definition at line 761 of file ScalingPolicy.h.

ThresholdHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::ThresholdHasBeenSet ( ) const

inline

Metric value used to trigger a scaling event.

Definition at line 473 of file ScalingPolicy.h.

UpdateStatusHasBeenSet()

bool Aws::GameLift::Model::ScalingPolicy::UpdateStatusHasBeenSet ( ) const

inline

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.

Definition at line 796 of file ScalingPolicy.h.

WithComparisonOperator() [1/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithComparisonOperator ( ComparisonOperatorType &&  value )

inline

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

Definition at line 462 of file ScalingPolicy.h.

WithComparisonOperator() [2/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithComparisonOperator ( const ComparisonOperatorType &  value )

inline

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

Definition at line 456 of file ScalingPolicy.h.

WithEvaluationPeriods()

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithEvaluationPeriods ( int  value )

inline

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

Definition at line 508 of file ScalingPolicy.h.

WithFleetArn() [1/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithFleetArn ( Aws::String &&  value )

inline

The Amazon Resource Name (ARN) that is assigned to a GameLift 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.

Definition at line 164 of file ScalingPolicy.h.

WithFleetArn() [2/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithFleetArn ( const Aws::String &  value )

inline

The Amazon Resource Name (ARN) that is assigned to a GameLift 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.

Definition at line 155 of file ScalingPolicy.h.

WithFleetArn() [3/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithFleetArn ( const char *  value )

inline

The Amazon Resource Name (ARN) that is assigned to a GameLift 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.

Definition at line 173 of file ScalingPolicy.h.

WithFleetId() [1/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithFleetId ( Aws::String &&  value )

inline

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

Definition at line 94 of file ScalingPolicy.h.

WithFleetId() [2/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithFleetId ( const Aws::String &  value )

inline

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

Definition at line 88 of file ScalingPolicy.h.

WithFleetId() [3/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithFleetId ( const char *  value )

inline

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

Definition at line 100 of file ScalingPolicy.h.

WithLocation() [1/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithLocation ( Aws::String &&  value )

inline

Definition at line 860 of file ScalingPolicy.h.

WithLocation() [2/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithLocation ( const Aws::String &  value )

inline

Definition at line 855 of file ScalingPolicy.h.

WithLocation() [3/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithLocation ( const char *  value )

inline

Definition at line 865 of file ScalingPolicy.h.

WithMetricName() [1/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithMetricName ( const MetricName &  value )

inline

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.

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

Definition at line 659 of file ScalingPolicy.h.

WithMetricName() [2/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithMetricName ( MetricName &&  value )

inline

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.

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

Definition at line 689 of file ScalingPolicy.h.

WithName() [1/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithName ( Aws::String &&  value )

inline

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

Definition at line 216 of file ScalingPolicy.h.

WithName() [2/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithName ( const Aws::String &  value )

inline

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

Definition at line 210 of file ScalingPolicy.h.

WithName() [3/3]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithName ( const char *  value )

inline

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

Definition at line 222 of file ScalingPolicy.h.

WithPolicyType() [1/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithPolicyType ( const PolicyType &  value )

inline

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.

Definition at line 740 of file ScalingPolicy.h.

WithPolicyType() [2/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithPolicyType ( PolicyType &&  value )

inline

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.

Definition at line 750 of file ScalingPolicy.h.

WithScalingAdjustment()

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithScalingAdjustment ( int  value )

inline

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

Definition at line 352 of file ScalingPolicy.h.

WithScalingAdjustmentType() [1/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithScalingAdjustmentType ( const ScalingAdjustmentType &  value )

inline

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.

Definition at line 413 of file ScalingPolicy.h.

WithScalingAdjustmentType() [2/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithScalingAdjustmentType ( ScalingAdjustmentType &&  value )

inline

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.

Definition at line 425 of file ScalingPolicy.h.

WithStatus() [1/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithStatus ( const ScalingStatusType &  value )

inline

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.

• ACTIVE – The scaling policy can be used for auto-scaling a fleet.

• UPDATE_REQUESTED – A request to update the scaling policy has been received.

• UPDATING – A change is being made to the scaling policy.

• DELETE_REQUESTED – A request to delete the scaling policy has been received.

• DELETING – The scaling policy is being deleted.

• DELETED – The scaling policy has been deleted.

• ERROR – An error occurred in creating the policy. It should be removed and recreated.

Definition at line 313 of file ScalingPolicy.h.

WithStatus() [2/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithStatus ( ScalingStatusType &&  value )

inline

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.

• ACTIVE – The scaling policy can be used for auto-scaling a fleet.

• UPDATE_REQUESTED – A request to update the scaling policy has been received.

• UPDATING – A change is being made to the scaling policy.

• DELETE_REQUESTED – A request to delete the scaling policy has been received.

• DELETING – The scaling policy is being deleted.

• DELETED – The scaling policy has been deleted.

• ERROR – An error occurred in creating the policy. It should be removed and recreated.

Definition at line 331 of file ScalingPolicy.h.

WithTargetConfiguration() [1/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithTargetConfiguration ( const TargetConfiguration &  value )

inline

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

Definition at line 776 of file ScalingPolicy.h.

WithTargetConfiguration() [2/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithTargetConfiguration ( TargetConfiguration &&  value )

inline

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

Definition at line 781 of file ScalingPolicy.h.

WithThreshold()

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithThreshold ( double  value )

inline

Metric value used to trigger a scaling event.

Definition at line 483 of file ScalingPolicy.h.

WithUpdateStatus() [1/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithUpdateStatus ( const LocationUpdateStatus &  value )

inline

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.

Definition at line 817 of file ScalingPolicy.h.

WithUpdateStatus() [2/2]

ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::WithUpdateStatus ( LocationUpdateStatus &&  value )

inline

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.

Definition at line 824 of file ScalingPolicy.h.

---

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

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