java.lang.Object
- software.amazon.awssdk.services.gamelift.model.Instance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Instance.Builder,Instance>
```
@Generated("software.amazon.awssdk:codegen")
public final class Instance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Instance.Builder,Instance>
```
Represents a virtual computing instance that runs game server processes and hosts game sessions. In Amazon GameLift, one or more instances make up a managed EC2 fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Instance.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Instance.Builder`	`builder()`
`Instant`	`creationTime()`	A time stamp indicating when this data object was created.
`String`	`dnsName()`	The DNS identifier assigned to the instance that is running the game session.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fleetArn()`	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
`String`	`fleetId()`	A unique identifier for the fleet that the instance belongs to.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`instanceId()`	A unique identifier for the instance.
`String`	`ipAddress()`	IP address that is assigned to the instance.
`String`	`location()`	The fleet location of the instance, expressed as an Amazon Web Services Region code, such as `us-west-2`.
`OperatingSystem`	`operatingSystem()`	Operating system that is running on this EC2 instance.
`String`	`operatingSystemAsString()`	Operating system that is running on this EC2 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 final String fleetId()
```
    A unique identifier for the fleet that the instance belongs to.
    
    Returns:
    
    A unique identifier for the fleet that the instance belongs to.
  - fleetArn
```
public final String fleetArn()
```
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .
    
    Returns:
    
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
  - instanceId
```
public final String instanceId()
```
    A unique identifier for the instance.
    
    Returns:
    
    A unique identifier for the instance.
  - ipAddress
```
public final String ipAddress()
```
    IP address that is assigned to the instance.
    
    Returns:
    
    IP address that is assigned to the instance.
  - dnsName
```
public final String dnsName()
```
    The 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 Elastic Compute Cloud 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:
    
    The 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 Elastic Compute Cloud 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 final OperatingSystem operatingSystem()
```
    Operating system that is running on this EC2 instance.
    
    Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
    
    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 EC2 instance.
    
    Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
    
    See Also:
    
    OperatingSystem
  - operatingSystemAsString
```
public final String operatingSystemAsString()
```
    Operating system that is running on this EC2 instance.
    
    Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
    
    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 EC2 instance.
    
    Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
    
    See Also:
    
    OperatingSystem
  - type
```
public final 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 final 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 final 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 final 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 final Instant creationTime()
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - location
```
public final String location()
```
    The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.
    
    Returns:
    
    The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.
  - 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 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

Class Instance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

fleetId

fleetArn

instanceId

ipAddress

dnsName

operatingSystem

operatingSystemAsString

type

typeAsString

status

statusAsString

creationTime

location

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields