GameServerInstance (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.model.GameServerInstance

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GameServerInstance
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GameServerInstance()

Constructors
Constructor and Description
`GameServerInstance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GameServerInstance`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getGameServerGroupArn()` A generated unique identifier for the game server group that includes the game server instance.
`String`	`getGameServerGroupName()` A developer-defined identifier for the game server group that includes the game server instance.
`String`	`getInstanceId()` The unique identifier for the instance where the game server is running.
`String`	`getInstanceStatus()` Current status of the game server instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGameServerGroupArn(String gameServerGroupArn)` A generated unique identifier for the game server group that includes the game server instance.
`void`	`setGameServerGroupName(String gameServerGroupName)` A developer-defined identifier for the game server group that includes the game server instance.
`void`	`setInstanceId(String instanceId)` The unique identifier for the instance where the game server is running.
`void`	`setInstanceStatus(String instanceStatus)` Current status of the game server instance.
`String`	`toString()` Returns a string representation of this object.
`GameServerInstance`	`withGameServerGroupArn(String gameServerGroupArn)` A generated unique identifier for the game server group that includes the game server instance.
`GameServerInstance`	`withGameServerGroupName(String gameServerGroupName)` A developer-defined identifier for the game server group that includes the game server instance.
`GameServerInstance`	`withInstanceId(String instanceId)` The unique identifier for the instance where the game server is running.
`GameServerInstance`	`withInstanceStatus(GameServerInstanceStatus instanceStatus)` Current status of the game server instance.
`GameServerInstance`	`withInstanceStatus(String instanceStatus)` Current status of the game server instance.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GameServerInstance
```
public GameServerInstance()
```
- Method Detail
  - setGameServerGroupName
```
public void setGameServerGroupName(String gameServerGroupName)
```
    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.
    
    Parameters:
    
    gameServerGroupName - 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.
  - getGameServerGroupName
```
public String getGameServerGroupName()
```
    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.
    
    Returns:
    
    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.
  - withGameServerGroupName
```
public GameServerInstance withGameServerGroupName(String gameServerGroupName)
```
    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.
    
    Parameters:
    
    gameServerGroupName - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGameServerGroupArn
```
public void setGameServerGroupArn(String gameServerGroupArn)
```
    A generated unique identifier for the game server group that includes the game server instance.
    
    Parameters:
    
    gameServerGroupArn - A generated unique identifier for the game server group that includes the game server instance.
  - getGameServerGroupArn
```
public String getGameServerGroupArn()
```
    A generated unique identifier for the game server group that includes the game server instance.
    
    Returns:
    
    A generated unique identifier for the game server group that includes the game server instance.
  - withGameServerGroupArn
```
public GameServerInstance withGameServerGroupArn(String gameServerGroupArn)
```
    A generated unique identifier for the game server group that includes the game server instance.
    
    Parameters:
    
    gameServerGroupArn - A generated unique identifier for the game server group that includes the game server instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    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.
    
    Parameters:
    
    instanceId - 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.
  - getInstanceId
```
public String getInstanceId()
```
    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:
    
    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.
  - withInstanceId
```
public GameServerInstance withInstanceId(String instanceId)
```
    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.
    
    Parameters:
    
    instanceId - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceStatus
```
public void setInstanceStatus(String instanceStatus)
```
    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.
    Parameters:
    instanceStatus - 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:
    
    GameServerInstanceStatus
  - getInstanceStatus
```
public String getInstanceStatus()
```
    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.
    Returns:
    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:
    
    GameServerInstanceStatus
  - withInstanceStatus
```
public GameServerInstance withInstanceStatus(String instanceStatus)
```
    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.
    Parameters:
    instanceStatus - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameServerInstanceStatus
  - withInstanceStatus
```
public GameServerInstance withInstanceStatus(GameServerInstanceStatus instanceStatus)
```
    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.
    Parameters:
    instanceStatus - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GameServerInstanceStatus
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GameServerInstance clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class GameServerInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GameServerInstance

Method Detail

setGameServerGroupName

getGameServerGroupName

withGameServerGroupName

setGameServerGroupArn

getGameServerGroupArn

withGameServerGroupArn

setInstanceId

getInstanceId

withInstanceId

setInstanceStatus

getInstanceStatus

withInstanceStatus

withInstanceStatus

toString

equals

hashCode

clone

marshall