Struct aws_sdk_gamelift::model::GameServer

#[non_exhaustive]
pub struct GameServer {
    pub game_server_group_name: Option<String>,
    pub game_server_group_arn: Option<String>,
    pub game_server_id: Option<String>,
    pub instance_id: Option<String>,
    pub connection_info: Option<String>,
    pub game_server_data: Option<String>,
    pub claim_status: Option<GameServerClaimStatus>,
    pub utilization_status: Option<GameServerUtilizationStatus>,
    pub registration_time: Option<DateTime>,
    pub last_claim_time: Option<DateTime>,
    pub last_health_check_time: Option<DateTime>,
}

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

Properties describing a game server that is running on an instance in a GameServerGroup.

A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

game_server_group_name: Option<String>

A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

game_server_group_arn: Option<String>

The ARN identifier for the game server group where the game server is located.

game_server_id: Option<String>

A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

instance_id: Option<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.

connection_info: Option<String>

The port and IP address that must be used to establish a client connection to the game server.

game_server_data: Option<String>

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

claim_status: Option<GameServerClaimStatus>

Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

utilization_status: Option<GameServerUtilizationStatus>

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

• AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

• UTILIZED - The game server is currently hosting a game session with players.

registration_time: Option<DateTime>

Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

last_claim_time: Option<DateTime>

Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

last_health_check_time: Option<DateTime>

Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Implementations

impl GameServer

pub fn game_server_group_name(&self) -> Option<&str>

A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

pub fn game_server_group_arn(&self) -> Option<&str>

The ARN identifier for the game server group where the game server is located.

pub fn game_server_id(&self) -> Option<&str>

A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

pub fn instance_id(&self) -> Option<&str>

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.

pub fn connection_info(&self) -> Option<&str>

The port and IP address that must be used to establish a client connection to the game server.

pub fn game_server_data(&self) -> Option<&str>

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

pub fn claim_status(&self) -> Option<&GameServerClaimStatus>

Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

pub fn utilization_status(&self) -> Option<&GameServerUtilizationStatus>

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

• AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

• UTILIZED - The game server is currently hosting a game session with players.

pub fn registration_time(&self) -> Option<&DateTime>

Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn last_claim_time(&self) -> Option<&DateTime>

Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

pub fn last_health_check_time(&self) -> Option<&DateTime>

Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

impl GameServer

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GameServer

Trait Implementations

impl Clone for GameServer

fn clone(&self) -> GameServer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GameServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<GameServer> for GameServer

fn eq(&self, other: &GameServer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GameServer) -> bool

This method tests for !=.

impl StructuralPartialEq for GameServer