software.amazon.awssdk.services.gamelift.model

Class GameServerInstance

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameServerInstance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GameServerInstance.Builder,GameServerInstance>

@Generated(value="software.amazon.awssdk:codegen")
public final class GameServerInstance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GameServerInstance.Builder,GameServerInstance>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GameServerInstance.Builder

Method Summary

Modifier and Type	Method and Description
static GameServerInstance.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerGroupArn() A generated unique identifier for the game server group that includes the game server instance.
String	gameServerGroupName() A developer-defined identifier for the game server group that includes the game server instance.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId() The unique identifier for the instance where the game server is running.
GameServerInstanceStatus	instanceStatus() Current status of the game server instance.
String	instanceStatusAsString() Current status of the game server instance.
List<SdkField<?>>	sdkFields()
static Class<? extends GameServerInstance.Builder>	serializableBuilderClass()
GameServerInstance.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

gameServerGroupName

public final 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 Amazon Web Services 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 Amazon Web Services account.

gameServerGroupArn

public final String gameServerGroupArn()

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.

instanceId

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

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.

instanceStatus

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

If the service returns an enum value that is not available in the current SDK version, instanceStatus will return GameServerInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceStatusAsString().

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

instanceStatusAsString

public final String instanceStatusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, instanceStatus will return GameServerInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceStatusAsString().

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

toBuilder

public GameServerInstance.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GameServerInstance.Builder,GameServerInstance>

builder

public static GameServerInstance.Builder builder()

serializableBuilderClass

public static Class<? extends GameServerInstance.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo