Struct aws_sdk_gamelift::model::GameServerInstance

#[non_exhaustive]
pub struct GameServerInstance {
    pub game_server_group_name: Option<String>,
    pub game_server_group_arn: Option<String>,
    pub instance_id: Option<String>,
    pub instance_status: Option<GameServerInstanceStatus>,
}

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

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

game_server_group_arn: Option<String>

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

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.

instance_status: Option<GameServerInstanceStatus>

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.

Implementations

impl GameServerInstance

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

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.

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

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

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 instance_status(&self) -> Option<&GameServerInstanceStatus>

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.

impl GameServerInstance

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GameServerInstance

Trait Implementations

impl Clone for GameServerInstance

fn clone(&self) -> GameServerInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameServerInstance

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

Formats the value using the given formatter.

impl PartialEq<GameServerInstance> for GameServerInstance

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

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

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

This method tests for !=.

impl StructuralPartialEq for GameServerInstance