Package software.amazon.awssdk.services.gamelift.model

Class Instance

java.lang.Object

software.amazon.awssdk.services.gamelift.model.Instance

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Instance.Builder,Instance>

@Generated("software.amazon.awssdk:codegen")
public class Instance
extends Object
implements StructuredPojo, ToCopyableBuilder<Instance.Builder,Instance>

Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet contains zero or more instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Instance.Builder

Method Summary

Modifier and Type	Method	Description
static Instance.Builder	builder()
Date	creationTime()	Time stamp indicating when this data object was created.
boolean	equals(Object obj)
String	fleetId()	Unique identifier for a fleet that the instance is in.
int	hashCode()
String	instanceId()	Unique identifier for an instance.
String	ipAddress()	IP address assigned to the instance.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	operatingSystem()	Operating system that is running on this instance.
static Class<? extends Instance.Builder>	serializableBuilderClass()
String	status()	Current status of the instance.
Instance.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	EC2 instance type that defines the computing resources of this instance.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

fleetId

public String fleetId()

Unique identifier for a fleet that the instance is in.

Returns:

Unique identifier for a fleet that the instance is in.

instanceId

public String instanceId()

Unique identifier for an instance.

Returns:

Unique identifier for an instance.

ipAddress

public String ipAddress()

IP address assigned to the instance.

Returns:

IP address assigned to the instance.

operatingSystem

public String operatingSystem()

Operating system that is running on this instance.

Returns:

Operating system that is running on this instance.

See Also:

OperatingSystem

type

public String type()

EC2 instance type that defines the computing resources of this instance.

Returns:

EC2 instance type that defines the computing resources of this instance.

See Also:

EC2InstanceType

status

public String status()

Current status of the instance. Possible statuses include the following:

• PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's runtime configuration.

• ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

• TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

Returns:

Current status of the instance. Possible statuses include the following:

• PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's runtime configuration.

• ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

• TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

See Also:

InstanceStatus

creationTime

public Date creationTime()

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

toBuilder

public Instance.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Instance.Builder,Instance>

Returns:

a builder for type T

builder

public static Instance.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

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