software.amazon.awssdk.services.gamelift.model

Class Instance

java.lang.Object

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

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Instance.Builder

Method Summary

Modifier and Type	Method and Description
static Instance.Builder	builder()
Instant	creationTime() Time stamp indicating when this data object was created.
String	dnsName() DNS identifier assigned to the instance that is running the game session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetId() A unique identifier for a fleet that the instance is in.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId() A unique identifier for an instance.
String	ipAddress() IP address that is assigned to the instance.
OperatingSystem	operatingSystem() Operating system that is running on this instance.
String	operatingSystemAsString() Operating system that is running on this instance.
List<SdkField<?>>	sdkFields()
static Class<? extends Instance.Builder>	serializableBuilderClass()
InstanceStatus	status() Current status of the instance.
String	statusAsString() Current status of the instance.
Instance.Builder	toBuilder()
String	toString() Returns a string representation of this object.
EC2InstanceType	type() EC2 instance type that defines the computing resources of this instance.
String	typeAsString() EC2 instance type that defines the computing resources of this instance.

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

fleetId

public String fleetId()

A unique identifier for a fleet that the instance is in.

Returns:

A unique identifier for a fleet that the instance is in.

instanceId

public String instanceId()

A unique identifier for an instance.

Returns:

A unique identifier for an instance.

ipAddress

public String ipAddress()

IP address that is assigned to the instance.

Returns:

IP address that is assigned to the instance.

dnsName

public String dnsName()

DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

• Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Returns:

DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

• Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

operatingSystem

public OperatingSystem operatingSystem()

Operating system that is running on this instance.

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

Returns:

Operating system that is running on this instance.

See Also:

OperatingSystem

operatingSystemAsString

public String operatingSystemAsString()

Operating system that is running on this instance.

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

Returns:

Operating system that is running on this instance.

See Also:

OperatingSystem

type

public EC2InstanceType type()

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

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

Returns:

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

See Also:

EC2InstanceType

typeAsString

public String typeAsString()

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

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

Returns:

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

See Also:

EC2InstanceType

status

public InstanceStatus 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 run-time 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.

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

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 run-time 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

statusAsString

public String statusAsString()

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 run-time 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.

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

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 run-time 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 Instant 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()

Specified by:

toBuilder in interface ToCopyableBuilder<Instance.Builder,Instance>

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

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo