AWS SDK for C++  1.7.207
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::PutScalingPolicyRequest Class Reference

#include <PutScalingPolicyRequest.h>

+ Inheritance diagram for Aws::GameLift::Model::PutScalingPolicyRequest:

Public Member Functions

 PutScalingPolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PutScalingPolicyRequestWithName (const Aws::String &value)
 
PutScalingPolicyRequestWithName (Aws::String &&value)
 
PutScalingPolicyRequestWithName (const char *value)
 
const Aws::StringGetFleetId () const
 
bool FleetIdHasBeenSet () const
 
void SetFleetId (const Aws::String &value)
 
void SetFleetId (Aws::String &&value)
 
void SetFleetId (const char *value)
 
PutScalingPolicyRequestWithFleetId (const Aws::String &value)
 
PutScalingPolicyRequestWithFleetId (Aws::String &&value)
 
PutScalingPolicyRequestWithFleetId (const char *value)
 
int GetScalingAdjustment () const
 
bool ScalingAdjustmentHasBeenSet () const
 
void SetScalingAdjustment (int value)
 
PutScalingPolicyRequestWithScalingAdjustment (int value)
 
const ScalingAdjustmentTypeGetScalingAdjustmentType () const
 
bool ScalingAdjustmentTypeHasBeenSet () const
 
void SetScalingAdjustmentType (const ScalingAdjustmentType &value)
 
void SetScalingAdjustmentType (ScalingAdjustmentType &&value)
 
PutScalingPolicyRequestWithScalingAdjustmentType (const ScalingAdjustmentType &value)
 
PutScalingPolicyRequestWithScalingAdjustmentType (ScalingAdjustmentType &&value)
 
double GetThreshold () const
 
bool ThresholdHasBeenSet () const
 
void SetThreshold (double value)
 
PutScalingPolicyRequestWithThreshold (double value)
 
const ComparisonOperatorTypeGetComparisonOperator () const
 
bool ComparisonOperatorHasBeenSet () const
 
void SetComparisonOperator (const ComparisonOperatorType &value)
 
void SetComparisonOperator (ComparisonOperatorType &&value)
 
PutScalingPolicyRequestWithComparisonOperator (const ComparisonOperatorType &value)
 
PutScalingPolicyRequestWithComparisonOperator (ComparisonOperatorType &&value)
 
int GetEvaluationPeriods () const
 
bool EvaluationPeriodsHasBeenSet () const
 
void SetEvaluationPeriods (int value)
 
PutScalingPolicyRequestWithEvaluationPeriods (int value)
 
const MetricNameGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const MetricName &value)
 
void SetMetricName (MetricName &&value)
 
PutScalingPolicyRequestWithMetricName (const MetricName &value)
 
PutScalingPolicyRequestWithMetricName (MetricName &&value)
 
const PolicyTypeGetPolicyType () const
 
bool PolicyTypeHasBeenSet () const
 
void SetPolicyType (const PolicyType &value)
 
void SetPolicyType (PolicyType &&value)
 
PutScalingPolicyRequestWithPolicyType (const PolicyType &value)
 
PutScalingPolicyRequestWithPolicyType (PolicyType &&value)
 
const TargetConfigurationGetTargetConfiguration () const
 
bool TargetConfigurationHasBeenSet () const
 
void SetTargetConfiguration (const TargetConfiguration &value)
 
void SetTargetConfiguration (TargetConfiguration &&value)
 
PutScalingPolicyRequestWithTargetConfiguration (const TargetConfiguration &value)
 
PutScalingPolicyRequestWithTargetConfiguration (TargetConfiguration &&value)
 
- Public Member Functions inherited from Aws::GameLift::GameLiftRequest
virtual ~GameLiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the input for a request action.

See Also:

AWS API Reference

Definition at line 39 of file PutScalingPolicyRequest.h.

Constructor & Destructor Documentation

◆ PutScalingPolicyRequest()

Aws::GameLift::Model::PutScalingPolicyRequest::PutScalingPolicyRequest ( )

Member Function Documentation

◆ ComparisonOperatorHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::ComparisonOperatorHasBeenSet ( ) const
inline

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

Definition at line 292 of file PutScalingPolicyRequest.h.

◆ EvaluationPeriodsHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::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 329 of file PutScalingPolicyRequest.h.

◆ FleetIdHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::FleetIdHasBeenSet ( ) const
inline

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Definition at line 122 of file PutScalingPolicyRequest.h.

◆ GetComparisonOperator()

const ComparisonOperatorType& Aws::GameLift::Model::PutScalingPolicyRequest::GetComparisonOperator ( ) const
inline

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

Definition at line 286 of file PutScalingPolicyRequest.h.

◆ GetEvaluationPeriods()

int Aws::GameLift::Model::PutScalingPolicyRequest::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 323 of file PutScalingPolicyRequest.h.

◆ GetFleetId()

const Aws::String& Aws::GameLift::Model::PutScalingPolicyRequest::GetFleetId ( ) const
inline

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Definition at line 116 of file PutScalingPolicyRequest.h.

◆ GetMetricName()

const MetricName& Aws::GameLift::Model::PutScalingPolicyRequest::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.

  • CurrentPlayerSessionsPlayer 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 372 of file PutScalingPolicyRequest.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::PutScalingPolicyRequest::GetName ( ) const
inline

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Definition at line 60 of file PutScalingPolicyRequest.h.

◆ GetPolicyType()

const PolicyType& Aws::GameLift::Model::PutScalingPolicyRequest::GetPolicyType ( ) const
inline

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 533 of file PutScalingPolicyRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::GameLift::Model::PutScalingPolicyRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetScalingAdjustment()

int Aws::GameLift::Model::PutScalingPolicyRequest::GetScalingAdjustment ( ) const
inline

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

Definition at line 164 of file PutScalingPolicyRequest.h.

◆ GetScalingAdjustmentType()

const ScalingAdjustmentType& Aws::GameLift::Model::PutScalingPolicyRequest::GetScalingAdjustmentType ( ) const
inline

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; for example, a value of "-10" scales the fleet down by 10%.

Definition at line 193 of file PutScalingPolicyRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::GameLift::Model::PutScalingPolicyRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 48 of file PutScalingPolicyRequest.h.

◆ GetTargetConfiguration()

const TargetConfiguration& Aws::GameLift::Model::PutScalingPolicyRequest::GetTargetConfiguration ( ) const
inline

Object that contains settings for a target-based scaling policy.

Definition at line 589 of file PutScalingPolicyRequest.h.

◆ GetThreshold()

double Aws::GameLift::Model::PutScalingPolicyRequest::GetThreshold ( ) const
inline

Metric value used to trigger a scaling event.

Definition at line 264 of file PutScalingPolicyRequest.h.

◆ MetricNameHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::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.

  • CurrentPlayerSessionsPlayer 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 402 of file PutScalingPolicyRequest.h.

◆ NameHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::NameHasBeenSet ( ) const
inline

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Definition at line 67 of file PutScalingPolicyRequest.h.

◆ PolicyTypeHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::PolicyTypeHasBeenSet ( ) const
inline

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 543 of file PutScalingPolicyRequest.h.

◆ ScalingAdjustmentHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::ScalingAdjustmentHasBeenSet ( ) const
inline

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

Definition at line 169 of file PutScalingPolicyRequest.h.

◆ ScalingAdjustmentTypeHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::ScalingAdjustmentTypeHasBeenSet ( ) const
inline

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; for example, a value of "-10" scales the fleet down by 10%.

Definition at line 206 of file PutScalingPolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::GameLift::Model::PutScalingPolicyRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetComparisonOperator() [1/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetComparisonOperator ( const ComparisonOperatorType value)
inline

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

Definition at line 298 of file PutScalingPolicyRequest.h.

◆ SetComparisonOperator() [2/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetComparisonOperator ( ComparisonOperatorType &&  value)
inline

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

Definition at line 304 of file PutScalingPolicyRequest.h.

◆ SetEvaluationPeriods()

void Aws::GameLift::Model::PutScalingPolicyRequest::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 335 of file PutScalingPolicyRequest.h.

◆ SetFleetId() [1/3]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetFleetId ( const Aws::String value)
inline

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Definition at line 128 of file PutScalingPolicyRequest.h.

◆ SetFleetId() [2/3]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetFleetId ( Aws::String &&  value)
inline

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Definition at line 134 of file PutScalingPolicyRequest.h.

◆ SetFleetId() [3/3]

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

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Definition at line 140 of file PutScalingPolicyRequest.h.

◆ SetMetricName() [1/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::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.

  • CurrentPlayerSessionsPlayer 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 432 of file PutScalingPolicyRequest.h.

◆ SetMetricName() [2/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::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.

  • CurrentPlayerSessionsPlayer 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 462 of file PutScalingPolicyRequest.h.

◆ SetName() [1/3]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetName ( const Aws::String value)
inline

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Definition at line 74 of file PutScalingPolicyRequest.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetName ( Aws::String &&  value)
inline

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Definition at line 81 of file PutScalingPolicyRequest.h.

◆ SetName() [3/3]

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

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Definition at line 88 of file PutScalingPolicyRequest.h.

◆ SetPolicyType() [1/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetPolicyType ( const PolicyType value)
inline

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 553 of file PutScalingPolicyRequest.h.

◆ SetPolicyType() [2/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetPolicyType ( PolicyType &&  value)
inline

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 563 of file PutScalingPolicyRequest.h.

◆ SetScalingAdjustment()

void Aws::GameLift::Model::PutScalingPolicyRequest::SetScalingAdjustment ( int  value)
inline

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

Definition at line 174 of file PutScalingPolicyRequest.h.

◆ SetScalingAdjustmentType() [1/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetScalingAdjustmentType ( const ScalingAdjustmentType value)
inline

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; for example, a value of "-10" scales the fleet down by 10%.

Definition at line 219 of file PutScalingPolicyRequest.h.

◆ SetScalingAdjustmentType() [2/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetScalingAdjustmentType ( ScalingAdjustmentType &&  value)
inline

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; for example, a value of "-10" scales the fleet down by 10%.

Definition at line 232 of file PutScalingPolicyRequest.h.

◆ SetTargetConfiguration() [1/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetTargetConfiguration ( const TargetConfiguration value)
inline

Object that contains settings for a target-based scaling policy.

Definition at line 599 of file PutScalingPolicyRequest.h.

◆ SetTargetConfiguration() [2/2]

void Aws::GameLift::Model::PutScalingPolicyRequest::SetTargetConfiguration ( TargetConfiguration &&  value)
inline

Object that contains settings for a target-based scaling policy.

Definition at line 604 of file PutScalingPolicyRequest.h.

◆ SetThreshold()

void Aws::GameLift::Model::PutScalingPolicyRequest::SetThreshold ( double  value)
inline

Metric value used to trigger a scaling event.

Definition at line 274 of file PutScalingPolicyRequest.h.

◆ TargetConfigurationHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::TargetConfigurationHasBeenSet ( ) const
inline

Object that contains settings for a target-based scaling policy.

Definition at line 594 of file PutScalingPolicyRequest.h.

◆ ThresholdHasBeenSet()

bool Aws::GameLift::Model::PutScalingPolicyRequest::ThresholdHasBeenSet ( ) const
inline

Metric value used to trigger a scaling event.

Definition at line 269 of file PutScalingPolicyRequest.h.

◆ WithComparisonOperator() [1/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithComparisonOperator ( const ComparisonOperatorType value)
inline

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

Definition at line 310 of file PutScalingPolicyRequest.h.

◆ WithComparisonOperator() [2/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithComparisonOperator ( ComparisonOperatorType &&  value)
inline

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

Definition at line 316 of file PutScalingPolicyRequest.h.

◆ WithEvaluationPeriods()

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::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 341 of file PutScalingPolicyRequest.h.

◆ WithFleetId() [1/3]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithFleetId ( const Aws::String value)
inline

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Definition at line 146 of file PutScalingPolicyRequest.h.

◆ WithFleetId() [2/3]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithFleetId ( Aws::String &&  value)
inline

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Definition at line 152 of file PutScalingPolicyRequest.h.

◆ WithFleetId() [3/3]

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

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Definition at line 158 of file PutScalingPolicyRequest.h.

◆ WithMetricName() [1/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::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.

  • CurrentPlayerSessionsPlayer 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 492 of file PutScalingPolicyRequest.h.

◆ WithMetricName() [2/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::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.

  • CurrentPlayerSessionsPlayer 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 522 of file PutScalingPolicyRequest.h.

◆ WithName() [1/3]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithName ( const Aws::String value)
inline

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Definition at line 95 of file PutScalingPolicyRequest.h.

◆ WithName() [2/3]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithName ( Aws::String &&  value)
inline

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Definition at line 102 of file PutScalingPolicyRequest.h.

◆ WithName() [3/3]

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

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Definition at line 109 of file PutScalingPolicyRequest.h.

◆ WithPolicyType() [1/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithPolicyType ( const PolicyType value)
inline

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 573 of file PutScalingPolicyRequest.h.

◆ WithPolicyType() [2/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithPolicyType ( PolicyType &&  value)
inline

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 583 of file PutScalingPolicyRequest.h.

◆ WithScalingAdjustment()

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithScalingAdjustment ( int  value)
inline

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

Definition at line 179 of file PutScalingPolicyRequest.h.

◆ WithScalingAdjustmentType() [1/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithScalingAdjustmentType ( const ScalingAdjustmentType value)
inline

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; for example, a value of "-10" scales the fleet down by 10%.

Definition at line 245 of file PutScalingPolicyRequest.h.

◆ WithScalingAdjustmentType() [2/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithScalingAdjustmentType ( ScalingAdjustmentType &&  value)
inline

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; for example, a value of "-10" scales the fleet down by 10%.

Definition at line 258 of file PutScalingPolicyRequest.h.

◆ WithTargetConfiguration() [1/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithTargetConfiguration ( const TargetConfiguration value)
inline

Object that contains settings for a target-based scaling policy.

Definition at line 609 of file PutScalingPolicyRequest.h.

◆ WithTargetConfiguration() [2/2]

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithTargetConfiguration ( TargetConfiguration &&  value)
inline

Object that contains settings for a target-based scaling policy.

Definition at line 614 of file PutScalingPolicyRequest.h.

◆ WithThreshold()

PutScalingPolicyRequest& Aws::GameLift::Model::PutScalingPolicyRequest::WithThreshold ( double  value)
inline

Metric value used to trigger a scaling event.

Definition at line 279 of file PutScalingPolicyRequest.h.


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