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

#include <GameServerInstance.h>

Public Member Functions

 GameServerInstance ()
 
 GameServerInstance (Aws::Utils::Json::JsonView jsonValue)
 
GameServerInstanceoperator= (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)
 
GameServerInstanceWithGameServerGroupName (const Aws::String &value)
 
GameServerInstanceWithGameServerGroupName (Aws::String &&value)
 
GameServerInstanceWithGameServerGroupName (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)
 
GameServerInstanceWithGameServerGroupArn (const Aws::String &value)
 
GameServerInstanceWithGameServerGroupArn (Aws::String &&value)
 
GameServerInstanceWithGameServerGroupArn (const char *value)
 
const Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
GameServerInstanceWithInstanceId (const Aws::String &value)
 
GameServerInstanceWithInstanceId (Aws::String &&value)
 
GameServerInstanceWithInstanceId (const char *value)
 
const GameServerInstanceStatusGetInstanceStatus () const
 
bool InstanceStatusHasBeenSet () const
 
void SetInstanceStatus (const GameServerInstanceStatus &value)
 
void SetInstanceStatus (GameServerInstanceStatus &&value)
 
GameServerInstanceWithInstanceStatus (const GameServerInstanceStatus &value)
 
GameServerInstanceWithInstanceStatus (GameServerInstanceStatus &&value)
 

Detailed Description

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

Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.

Retrieve game server instances for a game server group by calling DescribeGameServerInstances.

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

See Also:

AWS API Reference

Definition at line 44 of file GameServerInstance.h.

Constructor & Destructor Documentation

◆ GameServerInstance() [1/2]

Aws::GameLift::Model::GameServerInstance::GameServerInstance ( )

◆ GameServerInstance() [2/2]

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

Member Function Documentation

◆ GameServerGroupArnHasBeenSet()

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

A generated unique identifier for the game server group that includes the game server instance.

Definition at line 120 of file GameServerInstance.h.

◆ GameServerGroupNameHasBeenSet()

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

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

Definition at line 65 of file GameServerInstance.h.

◆ GetGameServerGroupArn()

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

A generated unique identifier for the game server group that includes the game server instance.

Definition at line 114 of file GameServerInstance.h.

◆ GetGameServerGroupName()

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

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

Definition at line 58 of file GameServerInstance.h.

◆ GetInstanceId()

const Aws::String& Aws::GameLift::Model::GameServerInstance::GetInstanceId ( ) const
inline

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Definition at line 164 of file GameServerInstance.h.

◆ GetInstanceStatus()

const GameServerInstanceStatus& Aws::GameLift::Model::GameServerInstance::GetInstanceStatus ( ) const
inline

Current status of the game server instance.

  • ACTIVE – The instance is viable for hosting game servers.

  • DRAINING – The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

  • SPOT_TERMINATING – The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Definition at line 228 of file GameServerInstance.h.

◆ InstanceIdHasBeenSet()

bool Aws::GameLift::Model::GameServerInstance::InstanceIdHasBeenSet ( ) const
inline

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Definition at line 171 of file GameServerInstance.h.

◆ InstanceStatusHasBeenSet()

bool Aws::GameLift::Model::GameServerInstance::InstanceStatusHasBeenSet ( ) const
inline

Current status of the game server instance.

  • ACTIVE – The instance is viable for hosting game servers.

  • DRAINING – The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

  • SPOT_TERMINATING – The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Definition at line 242 of file GameServerInstance.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetGameServerGroupArn() [1/3]

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

A generated unique identifier for the game server group that includes the game server instance.

Definition at line 132 of file GameServerInstance.h.

◆ SetGameServerGroupArn() [2/3]

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

A generated unique identifier for the game server group that includes the game server instance.

Definition at line 126 of file GameServerInstance.h.

◆ SetGameServerGroupArn() [3/3]

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

A generated unique identifier for the game server group that includes the game server instance.

Definition at line 138 of file GameServerInstance.h.

◆ SetGameServerGroupName() [1/3]

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

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

Definition at line 79 of file GameServerInstance.h.

◆ SetGameServerGroupName() [2/3]

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

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

Definition at line 72 of file GameServerInstance.h.

◆ SetGameServerGroupName() [3/3]

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

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

Definition at line 86 of file GameServerInstance.h.

◆ SetInstanceId() [1/3]

void Aws::GameLift::Model::GameServerInstance::SetInstanceId ( Aws::String &&  value)
inline

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Definition at line 185 of file GameServerInstance.h.

◆ SetInstanceId() [2/3]

void Aws::GameLift::Model::GameServerInstance::SetInstanceId ( const Aws::String value)
inline

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Definition at line 178 of file GameServerInstance.h.

◆ SetInstanceId() [3/3]

void Aws::GameLift::Model::GameServerInstance::SetInstanceId ( const char *  value)
inline

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Definition at line 192 of file GameServerInstance.h.

◆ SetInstanceStatus() [1/2]

void Aws::GameLift::Model::GameServerInstance::SetInstanceStatus ( const GameServerInstanceStatus value)
inline

Current status of the game server instance.

  • ACTIVE – The instance is viable for hosting game servers.

  • DRAINING – The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

  • SPOT_TERMINATING – The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Definition at line 256 of file GameServerInstance.h.

◆ SetInstanceStatus() [2/2]

void Aws::GameLift::Model::GameServerInstance::SetInstanceStatus ( GameServerInstanceStatus &&  value)
inline

Current status of the game server instance.

  • ACTIVE – The instance is viable for hosting game servers.

  • DRAINING – The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

  • SPOT_TERMINATING – The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Definition at line 270 of file GameServerInstance.h.

◆ WithGameServerGroupArn() [1/3]

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

A generated unique identifier for the game server group that includes the game server instance.

Definition at line 150 of file GameServerInstance.h.

◆ WithGameServerGroupArn() [2/3]

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

A generated unique identifier for the game server group that includes the game server instance.

Definition at line 144 of file GameServerInstance.h.

◆ WithGameServerGroupArn() [3/3]

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

A generated unique identifier for the game server group that includes the game server instance.

Definition at line 156 of file GameServerInstance.h.

◆ WithGameServerGroupName() [1/3]

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

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

Definition at line 100 of file GameServerInstance.h.

◆ WithGameServerGroupName() [2/3]

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

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

Definition at line 93 of file GameServerInstance.h.

◆ WithGameServerGroupName() [3/3]

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

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

Definition at line 107 of file GameServerInstance.h.

◆ WithInstanceId() [1/3]

GameServerInstance& Aws::GameLift::Model::GameServerInstance::WithInstanceId ( Aws::String &&  value)
inline

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Definition at line 206 of file GameServerInstance.h.

◆ WithInstanceId() [2/3]

GameServerInstance& Aws::GameLift::Model::GameServerInstance::WithInstanceId ( const Aws::String value)
inline

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Definition at line 199 of file GameServerInstance.h.

◆ WithInstanceId() [3/3]

GameServerInstance& Aws::GameLift::Model::GameServerInstance::WithInstanceId ( const char *  value)
inline

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Definition at line 213 of file GameServerInstance.h.

◆ WithInstanceStatus() [1/2]

GameServerInstance& Aws::GameLift::Model::GameServerInstance::WithInstanceStatus ( const GameServerInstanceStatus value)
inline

Current status of the game server instance.

  • ACTIVE – The instance is viable for hosting game servers.

  • DRAINING – The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

  • SPOT_TERMINATING – The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Definition at line 284 of file GameServerInstance.h.

◆ WithInstanceStatus() [2/2]

GameServerInstance& Aws::GameLift::Model::GameServerInstance::WithInstanceStatus ( GameServerInstanceStatus &&  value)
inline

Current status of the game server instance.

  • ACTIVE – The instance is viable for hosting game servers.

  • DRAINING – The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

  • SPOT_TERMINATING – The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Definition at line 298 of file GameServerInstance.h.


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