/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::GameLift::GameServerInstance

NAME

Paws::GameLift::GameServerInstance

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::GameLift::GameServerInstance object:

$service_obj->Method(Att1 => { GameServerGroupArn => $value, ..., InstanceStatus => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::GameServerInstance object:

$result = $service_obj->Method(...);
$result->Att1->GameServerGroupArn

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 (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html)

ATTRIBUTES

GameServerGroupArn => Str

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

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

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

InstanceStatus => Str

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.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::GameLift

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues