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

#include <GameServerGroup.h>

Public Member Functions

 GameServerGroup ()
 
 GameServerGroup (Aws::Utils::Json::JsonView jsonValue)
 
GameServerGroupoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetGameServerGroupName () const
 
bool GameServerGroupNameHasBeenSet () const
 
void SetGameServerGroupName (const Aws::String &value)
 
void SetGameServerGroupName (Aws::String &&value)
 
void SetGameServerGroupName (const char *value)
 
GameServerGroupWithGameServerGroupName (const Aws::String &value)
 
GameServerGroupWithGameServerGroupName (Aws::String &&value)
 
GameServerGroupWithGameServerGroupName (const char *value)
 
const Aws::StringGetGameServerGroupArn () const
 
bool GameServerGroupArnHasBeenSet () const
 
void SetGameServerGroupArn (const Aws::String &value)
 
void SetGameServerGroupArn (Aws::String &&value)
 
void SetGameServerGroupArn (const char *value)
 
GameServerGroupWithGameServerGroupArn (const Aws::String &value)
 
GameServerGroupWithGameServerGroupArn (Aws::String &&value)
 
GameServerGroupWithGameServerGroupArn (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
GameServerGroupWithRoleArn (const Aws::String &value)
 
GameServerGroupWithRoleArn (Aws::String &&value)
 
GameServerGroupWithRoleArn (const char *value)
 
const Aws::Vector< InstanceDefinition > & GetInstanceDefinitions () const
 
bool InstanceDefinitionsHasBeenSet () const
 
void SetInstanceDefinitions (const Aws::Vector< InstanceDefinition > &value)
 
void SetInstanceDefinitions (Aws::Vector< InstanceDefinition > &&value)
 
GameServerGroupWithInstanceDefinitions (const Aws::Vector< InstanceDefinition > &value)
 
GameServerGroupWithInstanceDefinitions (Aws::Vector< InstanceDefinition > &&value)
 
GameServerGroupAddInstanceDefinitions (const InstanceDefinition &value)
 
GameServerGroupAddInstanceDefinitions (InstanceDefinition &&value)
 
const BalancingStrategyGetBalancingStrategy () const
 
bool BalancingStrategyHasBeenSet () const
 
void SetBalancingStrategy (const BalancingStrategy &value)
 
void SetBalancingStrategy (BalancingStrategy &&value)
 
GameServerGroupWithBalancingStrategy (const BalancingStrategy &value)
 
GameServerGroupWithBalancingStrategy (BalancingStrategy &&value)
 
const GameServerProtectionPolicyGetGameServerProtectionPolicy () const
 
bool GameServerProtectionPolicyHasBeenSet () const
 
void SetGameServerProtectionPolicy (const GameServerProtectionPolicy &value)
 
void SetGameServerProtectionPolicy (GameServerProtectionPolicy &&value)
 
GameServerGroupWithGameServerProtectionPolicy (const GameServerProtectionPolicy &value)
 
GameServerGroupWithGameServerProtectionPolicy (GameServerProtectionPolicy &&value)
 
const Aws::StringGetAutoScalingGroupArn () const
 
bool AutoScalingGroupArnHasBeenSet () const
 
void SetAutoScalingGroupArn (const Aws::String &value)
 
void SetAutoScalingGroupArn (Aws::String &&value)
 
void SetAutoScalingGroupArn (const char *value)
 
GameServerGroupWithAutoScalingGroupArn (const Aws::String &value)
 
GameServerGroupWithAutoScalingGroupArn (Aws::String &&value)
 
GameServerGroupWithAutoScalingGroupArn (const char *value)
 
const GameServerGroupStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const GameServerGroupStatus &value)
 
void SetStatus (GameServerGroupStatus &&value)
 
GameServerGroupWithStatus (const GameServerGroupStatus &value)
 
GameServerGroupWithStatus (GameServerGroupStatus &&value)
 
const Aws::StringGetStatusReason () const
 
bool StatusReasonHasBeenSet () const
 
void SetStatusReason (const Aws::String &value)
 
void SetStatusReason (Aws::String &&value)
 
void SetStatusReason (const char *value)
 
GameServerGroupWithStatusReason (const Aws::String &value)
 
GameServerGroupWithStatusReason (Aws::String &&value)
 
GameServerGroupWithStatusReason (const char *value)
 
const Aws::Vector< GameServerGroupAction > & GetSuspendedActions () const
 
bool SuspendedActionsHasBeenSet () const
 
void SetSuspendedActions (const Aws::Vector< GameServerGroupAction > &value)
 
void SetSuspendedActions (Aws::Vector< GameServerGroupAction > &&value)
 
GameServerGroupWithSuspendedActions (const Aws::Vector< GameServerGroupAction > &value)
 
GameServerGroupWithSuspendedActions (Aws::Vector< GameServerGroupAction > &&value)
 
GameServerGroupAddSuspendedActions (const GameServerGroupAction &value)
 
GameServerGroupAddSuspendedActions (GameServerGroupAction &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
GameServerGroupWithCreationTime (const Aws::Utils::DateTime &value)
 
GameServerGroupWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedTime () const
 
bool LastUpdatedTimeHasBeenSet () const
 
void SetLastUpdatedTime (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedTime (Aws::Utils::DateTime &&value)
 
GameServerGroupWithLastUpdatedTime (const Aws::Utils::DateTime &value)
 
GameServerGroupWithLastUpdatedTime (Aws::Utils::DateTime &&value)
 

Detailed Description

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding EC2 Auto Scaling group.

A game server group is created by a successful call to CreateGameServerGroup and deleted by calling DeleteGameServerGroup. Game server group activity can be temporarily suspended and resumed by calling SuspendGameServerGroup and ResumeGameServerGroup, respectively.

See Also:

AWS API Reference

Definition at line 51 of file GameServerGroup.h.

Constructor & Destructor Documentation

◆ GameServerGroup() [1/2]

Aws::GameLift::Model::GameServerGroup::GameServerGroup ( )

◆ GameServerGroup() [2/2]

Aws::GameLift::Model::GameServerGroup::GameServerGroup ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddInstanceDefinitions() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::AddInstanceDefinitions ( const InstanceDefinition value)
inline

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Definition at line 262 of file GameServerGroup.h.

◆ AddInstanceDefinitions() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::AddInstanceDefinitions ( InstanceDefinition &&  value)
inline

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Definition at line 269 of file GameServerGroup.h.

◆ AddSuspendedActions() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::AddSuspendedActions ( const GameServerGroupAction value)
inline

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Definition at line 721 of file GameServerGroup.h.

◆ AddSuspendedActions() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::AddSuspendedActions ( GameServerGroupAction &&  value)
inline

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Definition at line 727 of file GameServerGroup.h.

◆ AutoScalingGroupArnHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::AutoScalingGroupArnHasBeenSet ( ) const
inline

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Definition at line 470 of file GameServerGroup.h.

◆ BalancingStrategyHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::BalancingStrategyHasBeenSet ( ) const
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 310 of file GameServerGroup.h.

◆ CreationTimeHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::CreationTimeHasBeenSet ( ) const
inline

A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 742 of file GameServerGroup.h.

◆ GameServerGroupArnHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::GameServerGroupArnHasBeenSet ( ) const
inline

A generated unique ID for the game server group.

Definition at line 117 of file GameServerGroup.h.

◆ GameServerGroupNameHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::GameServerGroupNameHasBeenSet ( ) const
inline

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Definition at line 70 of file GameServerGroup.h.

◆ GameServerProtectionPolicyHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::GameServerProtectionPolicyHasBeenSet ( ) const
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

Definition at line 413 of file GameServerGroup.h.

◆ GetAutoScalingGroupArn()

const Aws::String& Aws::GameLift::Model::GameServerGroup::GetAutoScalingGroupArn ( ) const
inline

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Definition at line 464 of file GameServerGroup.h.

◆ GetBalancingStrategy()

const BalancingStrategy& Aws::GameLift::Model::GameServerGroup::GetBalancingStrategy ( ) const
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 290 of file GameServerGroup.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::GameServerGroup::GetCreationTime ( ) const
inline

A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 735 of file GameServerGroup.h.

◆ GetGameServerGroupArn()

const Aws::String& Aws::GameLift::Model::GameServerGroup::GetGameServerGroupArn ( ) const
inline

A generated unique ID for the game server group.

Definition at line 112 of file GameServerGroup.h.

◆ GetGameServerGroupName()

const Aws::String& Aws::GameLift::Model::GameServerGroup::GetGameServerGroupName ( ) const
inline

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Definition at line 64 of file GameServerGroup.h.

◆ GetGameServerProtectionPolicy()

const GameServerProtectionPolicy& Aws::GameLift::Model::GameServerGroup::GetGameServerProtectionPolicy ( ) const
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

Definition at line 402 of file GameServerGroup.h.

◆ GetInstanceDefinitions()

const Aws::Vector<InstanceDefinition>& Aws::GameLift::Model::GameServerGroup::GetInstanceDefinitions ( ) const
inline

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Definition at line 220 of file GameServerGroup.h.

◆ GetLastUpdatedTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::GameServerGroup::GetLastUpdatedTime ( ) const
inline

A timestamp that indicates when this game server group was last updated.

Definition at line 776 of file GameServerGroup.h.

◆ GetRoleArn()

const Aws::String& Aws::GameLift::Model::GameServerGroup::GetRoleArn ( ) const
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 156 of file GameServerGroup.h.

◆ GetStatus()

const GameServerGroupStatus& Aws::GameLift::Model::GameServerGroup::GetStatus ( ) const
inline

The current status of the game server group. Possible statuses include:

  • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

  • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

  • ACTIVE - The game server group has been successfully created.

  • DELETE_SCHEDULED - A request to delete the game server group has been received.

  • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

  • DELETED - The game server group has been successfully deleted.

  • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

Definition at line 526 of file GameServerGroup.h.

◆ GetStatusReason()

const Aws::String& Aws::GameLift::Model::GameServerGroup::GetStatusReason ( ) const
inline

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Definition at line 629 of file GameServerGroup.h.

◆ GetSuspendedActions()

const Aws::Vector<GameServerGroupAction>& Aws::GameLift::Model::GameServerGroup::GetSuspendedActions ( ) const
inline

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Definition at line 685 of file GameServerGroup.h.

◆ InstanceDefinitionsHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::InstanceDefinitionsHasBeenSet ( ) const
inline

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Definition at line 227 of file GameServerGroup.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::GameServerGroup::Jsonize ( ) const

◆ LastUpdatedTimeHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::LastUpdatedTimeHasBeenSet ( ) const
inline

A timestamp that indicates when this game server group was last updated.

Definition at line 781 of file GameServerGroup.h.

◆ operator=()

GameServerGroup& Aws::GameLift::Model::GameServerGroup::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::RoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 164 of file GameServerGroup.h.

◆ SetAutoScalingGroupArn() [1/3]

void Aws::GameLift::Model::GameServerGroup::SetAutoScalingGroupArn ( const Aws::String value)
inline

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Definition at line 476 of file GameServerGroup.h.

◆ SetAutoScalingGroupArn() [2/3]

void Aws::GameLift::Model::GameServerGroup::SetAutoScalingGroupArn ( Aws::String &&  value)
inline

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Definition at line 482 of file GameServerGroup.h.

◆ SetAutoScalingGroupArn() [3/3]

void Aws::GameLift::Model::GameServerGroup::SetAutoScalingGroupArn ( const char *  value)
inline

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Definition at line 488 of file GameServerGroup.h.

◆ SetBalancingStrategy() [1/2]

void Aws::GameLift::Model::GameServerGroup::SetBalancingStrategy ( const BalancingStrategy value)
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 330 of file GameServerGroup.h.

◆ SetBalancingStrategy() [2/2]

void Aws::GameLift::Model::GameServerGroup::SetBalancingStrategy ( BalancingStrategy &&  value)
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 350 of file GameServerGroup.h.

◆ SetCreationTime() [1/2]

void Aws::GameLift::Model::GameServerGroup::SetCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 749 of file GameServerGroup.h.

◆ SetCreationTime() [2/2]

void Aws::GameLift::Model::GameServerGroup::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 756 of file GameServerGroup.h.

◆ SetGameServerGroupArn() [1/3]

void Aws::GameLift::Model::GameServerGroup::SetGameServerGroupArn ( const Aws::String value)
inline

A generated unique ID for the game server group.

Definition at line 122 of file GameServerGroup.h.

◆ SetGameServerGroupArn() [2/3]

void Aws::GameLift::Model::GameServerGroup::SetGameServerGroupArn ( Aws::String &&  value)
inline

A generated unique ID for the game server group.

Definition at line 127 of file GameServerGroup.h.

◆ SetGameServerGroupArn() [3/3]

void Aws::GameLift::Model::GameServerGroup::SetGameServerGroupArn ( const char *  value)
inline

A generated unique ID for the game server group.

Definition at line 132 of file GameServerGroup.h.

◆ SetGameServerGroupName() [1/3]

void Aws::GameLift::Model::GameServerGroup::SetGameServerGroupName ( const Aws::String value)
inline

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Definition at line 76 of file GameServerGroup.h.

◆ SetGameServerGroupName() [2/3]

void Aws::GameLift::Model::GameServerGroup::SetGameServerGroupName ( Aws::String &&  value)
inline

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Definition at line 82 of file GameServerGroup.h.

◆ SetGameServerGroupName() [3/3]

void Aws::GameLift::Model::GameServerGroup::SetGameServerGroupName ( const char *  value)
inline

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Definition at line 88 of file GameServerGroup.h.

◆ SetGameServerProtectionPolicy() [1/2]

void Aws::GameLift::Model::GameServerGroup::SetGameServerProtectionPolicy ( const GameServerProtectionPolicy value)
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

Definition at line 424 of file GameServerGroup.h.

◆ SetGameServerProtectionPolicy() [2/2]

void Aws::GameLift::Model::GameServerGroup::SetGameServerProtectionPolicy ( GameServerProtectionPolicy &&  value)
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

Definition at line 435 of file GameServerGroup.h.

◆ SetInstanceDefinitions() [1/2]

void Aws::GameLift::Model::GameServerGroup::SetInstanceDefinitions ( const Aws::Vector< InstanceDefinition > &  value)
inline

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Definition at line 234 of file GameServerGroup.h.

◆ SetInstanceDefinitions() [2/2]

void Aws::GameLift::Model::GameServerGroup::SetInstanceDefinitions ( Aws::Vector< InstanceDefinition > &&  value)
inline

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Definition at line 241 of file GameServerGroup.h.

◆ SetLastUpdatedTime() [1/2]

void Aws::GameLift::Model::GameServerGroup::SetLastUpdatedTime ( const Aws::Utils::DateTime value)
inline

A timestamp that indicates when this game server group was last updated.

Definition at line 786 of file GameServerGroup.h.

◆ SetLastUpdatedTime() [2/2]

void Aws::GameLift::Model::GameServerGroup::SetLastUpdatedTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that indicates when this game server group was last updated.

Definition at line 791 of file GameServerGroup.h.

◆ SetRoleArn() [1/3]

void Aws::GameLift::Model::GameServerGroup::SetRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 172 of file GameServerGroup.h.

◆ SetRoleArn() [2/3]

void Aws::GameLift::Model::GameServerGroup::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 180 of file GameServerGroup.h.

◆ SetRoleArn() [3/3]

void Aws::GameLift::Model::GameServerGroup::SetRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 188 of file GameServerGroup.h.

◆ SetStatus() [1/2]

void Aws::GameLift::Model::GameServerGroup::SetStatus ( const GameServerGroupStatus value)
inline

The current status of the game server group. Possible statuses include:

  • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

  • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

  • ACTIVE - The game server group has been successfully created.

  • DELETE_SCHEDULED - A request to delete the game server group has been received.

  • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

  • DELETED - The game server group has been successfully deleted.

  • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

Definition at line 564 of file GameServerGroup.h.

◆ SetStatus() [2/2]

void Aws::GameLift::Model::GameServerGroup::SetStatus ( GameServerGroupStatus &&  value)
inline

The current status of the game server group. Possible statuses include:

  • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

  • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

  • ACTIVE - The game server group has been successfully created.

  • DELETE_SCHEDULED - A request to delete the game server group has been received.

  • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

  • DELETED - The game server group has been successfully deleted.

  • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

Definition at line 583 of file GameServerGroup.h.

◆ SetStatusReason() [1/3]

void Aws::GameLift::Model::GameServerGroup::SetStatusReason ( const Aws::String value)
inline

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Definition at line 643 of file GameServerGroup.h.

◆ SetStatusReason() [2/3]

void Aws::GameLift::Model::GameServerGroup::SetStatusReason ( Aws::String &&  value)
inline

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Definition at line 650 of file GameServerGroup.h.

◆ SetStatusReason() [3/3]

void Aws::GameLift::Model::GameServerGroup::SetStatusReason ( const char *  value)
inline

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Definition at line 657 of file GameServerGroup.h.

◆ SetSuspendedActions() [1/2]

void Aws::GameLift::Model::GameServerGroup::SetSuspendedActions ( const Aws::Vector< GameServerGroupAction > &  value)
inline

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Definition at line 697 of file GameServerGroup.h.

◆ SetSuspendedActions() [2/2]

void Aws::GameLift::Model::GameServerGroup::SetSuspendedActions ( Aws::Vector< GameServerGroupAction > &&  value)
inline

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Definition at line 703 of file GameServerGroup.h.

◆ StatusHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::StatusHasBeenSet ( ) const
inline

The current status of the game server group. Possible statuses include:

  • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

  • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

  • ACTIVE - The game server group has been successfully created.

  • DELETE_SCHEDULED - A request to delete the game server group has been received.

  • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

  • DELETED - The game server group has been successfully deleted.

  • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

Definition at line 545 of file GameServerGroup.h.

◆ StatusReasonHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::StatusReasonHasBeenSet ( ) const
inline

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Definition at line 636 of file GameServerGroup.h.

◆ SuspendedActionsHasBeenSet()

bool Aws::GameLift::Model::GameServerGroup::SuspendedActionsHasBeenSet ( ) const
inline

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Definition at line 691 of file GameServerGroup.h.

◆ WithAutoScalingGroupArn() [1/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithAutoScalingGroupArn ( const Aws::String value)
inline

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Definition at line 494 of file GameServerGroup.h.

◆ WithAutoScalingGroupArn() [2/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithAutoScalingGroupArn ( Aws::String &&  value)
inline

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Definition at line 500 of file GameServerGroup.h.

◆ WithAutoScalingGroupArn() [3/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithAutoScalingGroupArn ( const char *  value)
inline

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Definition at line 506 of file GameServerGroup.h.

◆ WithBalancingStrategy() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithBalancingStrategy ( const BalancingStrategy value)
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 370 of file GameServerGroup.h.

◆ WithBalancingStrategy() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithBalancingStrategy ( BalancingStrategy &&  value)
inline

Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

  • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

  • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

  • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

Definition at line 390 of file GameServerGroup.h.

◆ WithCreationTime() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 763 of file GameServerGroup.h.

◆ WithCreationTime() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that indicates when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Definition at line 770 of file GameServerGroup.h.

◆ WithGameServerGroupArn() [1/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithGameServerGroupArn ( const Aws::String value)
inline

A generated unique ID for the game server group.

Definition at line 137 of file GameServerGroup.h.

◆ WithGameServerGroupArn() [2/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithGameServerGroupArn ( Aws::String &&  value)
inline

A generated unique ID for the game server group.

Definition at line 142 of file GameServerGroup.h.

◆ WithGameServerGroupArn() [3/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithGameServerGroupArn ( const char *  value)
inline

A generated unique ID for the game server group.

Definition at line 147 of file GameServerGroup.h.

◆ WithGameServerGroupName() [1/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithGameServerGroupName ( const Aws::String value)
inline

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Definition at line 94 of file GameServerGroup.h.

◆ WithGameServerGroupName() [2/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithGameServerGroupName ( Aws::String &&  value)
inline

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Definition at line 100 of file GameServerGroup.h.

◆ WithGameServerGroupName() [3/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithGameServerGroupName ( const char *  value)
inline

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Definition at line 106 of file GameServerGroup.h.

◆ WithGameServerProtectionPolicy() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithGameServerProtectionPolicy ( const GameServerProtectionPolicy value)
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

Definition at line 446 of file GameServerGroup.h.

◆ WithGameServerProtectionPolicy() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithGameServerProtectionPolicy ( GameServerProtectionPolicy &&  value)
inline

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

Definition at line 457 of file GameServerGroup.h.

◆ WithInstanceDefinitions() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithInstanceDefinitions ( const Aws::Vector< InstanceDefinition > &  value)
inline

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Definition at line 248 of file GameServerGroup.h.

◆ WithInstanceDefinitions() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithInstanceDefinitions ( Aws::Vector< InstanceDefinition > &&  value)
inline

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Definition at line 255 of file GameServerGroup.h.

◆ WithLastUpdatedTime() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithLastUpdatedTime ( const Aws::Utils::DateTime value)
inline

A timestamp that indicates when this game server group was last updated.

Definition at line 796 of file GameServerGroup.h.

◆ WithLastUpdatedTime() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithLastUpdatedTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that indicates when this game server group was last updated.

Definition at line 801 of file GameServerGroup.h.

◆ WithRoleArn() [1/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 196 of file GameServerGroup.h.

◆ WithRoleArn() [2/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 204 of file GameServerGroup.h.

◆ WithRoleArn() [3/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Definition at line 212 of file GameServerGroup.h.

◆ WithStatus() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithStatus ( const GameServerGroupStatus value)
inline

The current status of the game server group. Possible statuses include:

  • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

  • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

  • ACTIVE - The game server group has been successfully created.

  • DELETE_SCHEDULED - A request to delete the game server group has been received.

  • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

  • DELETED - The game server group has been successfully deleted.

  • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

Definition at line 602 of file GameServerGroup.h.

◆ WithStatus() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithStatus ( GameServerGroupStatus &&  value)
inline

The current status of the game server group. Possible statuses include:

  • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

  • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

  • ACTIVE - The game server group has been successfully created.

  • DELETE_SCHEDULED - A request to delete the game server group has been received.

  • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

  • DELETED - The game server group has been successfully deleted.

  • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

Definition at line 621 of file GameServerGroup.h.

◆ WithStatusReason() [1/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithStatusReason ( const Aws::String value)
inline

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Definition at line 664 of file GameServerGroup.h.

◆ WithStatusReason() [2/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithStatusReason ( Aws::String &&  value)
inline

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Definition at line 671 of file GameServerGroup.h.

◆ WithStatusReason() [3/3]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithStatusReason ( const char *  value)
inline

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Definition at line 678 of file GameServerGroup.h.

◆ WithSuspendedActions() [1/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithSuspendedActions ( const Aws::Vector< GameServerGroupAction > &  value)
inline

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Definition at line 709 of file GameServerGroup.h.

◆ WithSuspendedActions() [2/2]

GameServerGroup& Aws::GameLift::Model::GameServerGroup::WithSuspendedActions ( Aws::Vector< GameServerGroupAction > &&  value)
inline

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Definition at line 715 of file GameServerGroup.h.


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