AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::DescribeGameServerInstancesInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeGameServerInstancesInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  game_server_group_name: "GameServerGroupNameOrArn", # required
  instance_ids: ["GameServerInstanceId"],
  limit: 1,
  next_token: "NonZeroAndMaxString",
}

Instance Attribute Summary collapse

Instance Attribute Details

#game_server_group_nameString

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

Returns:

  • (String)

    A unique identifier for the game server group.

#instance_idsArray<String>

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

Returns:

  • (Array<String>)

    The EC2 instance IDs that you want to retrieve status on.

#limitInteger

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.

Returns:

  • (Integer)

    The maximum number of results to return.

#next_tokenString

A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

Returns:

  • (String)

    A token that indicates the start of the next sequential segment of results.