Class: Aws::GameLift::Types::GameServerInstance

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-gamelift/types.rb

Overview

**This data type is used with the Amazon 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`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#game_server_group_arn ⇒ String

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

Returns:

  • (String) 


5909
5910
5911
5912
5913
5914
5915
5916
 
# File 'lib/aws-sdk-gamelift/types.rb', line 5909

class GameServerInstance < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :instance_id,
  :instance_status)
  SENSITIVE = []
  include Aws::Structure
end

#game_server_group_name ⇒ String

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

Returns:

  • (String) 


5909
5910
5911
5912
5913
5914
5915
5916
 
# File 'lib/aws-sdk-gamelift/types.rb', line 5909

class GameServerInstance < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :instance_id,
  :instance_status)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

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

Returns:

  • (String) 


5909
5910
5911
5912
5913
5914
5915
5916
 
# File 'lib/aws-sdk-gamelift/types.rb', line 5909

class GameServerInstance < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :instance_id,
  :instance_status)
  SENSITIVE = []
  include Aws::Structure
end

#instance_status ⇒ String

Current status of the game server instance

Returns:

  • (String) 


5909
5910
5911
5912
5913
5914
5915
5916
 
# File 'lib/aws-sdk-gamelift/types.rb', line 5909

class GameServerInstance < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :instance_id,
  :instance_status)
  SENSITIVE = []
  include Aws::Structure
end