Instance (AWS SDK for Java

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

All Implemented Interfaces:

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

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Instance()

Constructors
Constructor and Description
`Instance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Instance`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` Time stamp indicating when this data object was created.
`String`	`getDnsName()` DNS identifier assigned to the instance that is running the game session.
`String`	`getFleetId()` A unique identifier for a fleet that the instance is in.
`String`	`getInstanceId()` A unique identifier for an instance.
`String`	`getIpAddress()` IP address that is assigned to the instance.
`String`	`getOperatingSystem()` Operating system that is running on this instance.
`String`	`getStatus()` Current status of the instance.
`String`	`getType()` EC2 instance type that defines the computing resources of this instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` Time stamp indicating when this data object was created.
`void`	`setDnsName(String dnsName)` DNS identifier assigned to the instance that is running the game session.
`void`	`setFleetId(String fleetId)` A unique identifier for a fleet that the instance is in.
`void`	`setInstanceId(String instanceId)` A unique identifier for an instance.
`void`	`setIpAddress(String ipAddress)` IP address that is assigned to the instance.
`void`	`setOperatingSystem(OperatingSystem operatingSystem)` Operating system that is running on this instance.
`void`	`setOperatingSystem(String operatingSystem)` Operating system that is running on this instance.
`void`	`setStatus(InstanceStatus status)` Current status of the instance.
`void`	`setStatus(String status)` Current status of the instance.
`void`	`setType(EC2InstanceType type)` EC2 instance type that defines the computing resources of this instance.
`void`	`setType(String type)` EC2 instance type that defines the computing resources of this instance.
`String`	`toString()` Returns a string representation of this object.
`Instance`	`withCreationTime(Date creationTime)` Time stamp indicating when this data object was created.
`Instance`	`withDnsName(String dnsName)` DNS identifier assigned to the instance that is running the game session.
`Instance`	`withFleetId(String fleetId)` A unique identifier for a fleet that the instance is in.
`Instance`	`withInstanceId(String instanceId)` A unique identifier for an instance.
`Instance`	`withIpAddress(String ipAddress)` IP address that is assigned to the instance.
`Instance`	`withOperatingSystem(OperatingSystem operatingSystem)` Operating system that is running on this instance.
`Instance`	`withOperatingSystem(String operatingSystem)` Operating system that is running on this instance.
`Instance`	`withStatus(InstanceStatus status)` Current status of the instance.
`Instance`	`withStatus(String status)` Current status of the instance.
`Instance`	`withType(EC2InstanceType type)` EC2 instance type that defines the computing resources of this instance.
`Instance`	`withType(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

- Constructor Detail
  - Instance
```
public Instance()
```
- Method Detail
  - setFleetId
```
public void setFleetId(String fleetId)
```
    A unique identifier for a fleet that the instance is in.
    
    Parameters:
    
    fleetId - A unique identifier for a fleet that the instance is in.
  - getFleetId
```
public String getFleetId()
```
    A unique identifier for a fleet that the instance is in.
    
    Returns:
    
    A unique identifier for a fleet that the instance is in.
  - withFleetId
```
public Instance withFleetId(String fleetId)
```
    A unique identifier for a fleet that the instance is in.
    
    Parameters:
    
    fleetId - A unique identifier for a fleet that the instance is in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    A unique identifier for an instance.
    
    Parameters:
    
    instanceId - A unique identifier for an instance.
  - getInstanceId
```
public String getInstanceId()
```
    A unique identifier for an instance.
    
    Returns:
    
    A unique identifier for an instance.
  - withInstanceId
```
public Instance withInstanceId(String instanceId)
```
    A unique identifier for an instance.
    
    Parameters:
    
    instanceId - A unique identifier for an instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    IP address that is assigned to the instance.
    
    Parameters:
    
    ipAddress - IP address that is assigned to the instance.
  - getIpAddress
```
public String getIpAddress()
```
    IP address that is assigned to the instance.
    
    Returns:
    
    IP address that is assigned to the instance.
  - withIpAddress
```
public Instance withIpAddress(String ipAddress)
```
    IP address that is assigned to the instance.
    
    Parameters:
    
    ipAddress - IP address that is assigned to the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDnsName
```
public void setDnsName(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.
    Parameters:
    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.
  - getDnsName
```
public String getDnsName()
```
    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.
  - withDnsName
```
public Instance withDnsName(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperatingSystem
```
public void setOperatingSystem(String operatingSystem)
```
    Operating system that is running on this instance.
    
    Parameters:
    
    operatingSystem - Operating system that is running on this instance.
    
    See Also:
    
    OperatingSystem
  - getOperatingSystem
```
public String getOperatingSystem()
```
    Operating system that is running on this instance.
    
    Returns:
    
    Operating system that is running on this instance.
    
    See Also:
    
    OperatingSystem
  - withOperatingSystem
```
public Instance withOperatingSystem(String operatingSystem)
```
    Operating system that is running on this instance.
    
    Parameters:
    
    operatingSystem - Operating system that is running on this instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OperatingSystem
  - setOperatingSystem
```
public void setOperatingSystem(OperatingSystem operatingSystem)
```
    Operating system that is running on this instance.
    
    Parameters:
    
    operatingSystem - Operating system that is running on this instance.
    
    See Also:
    
    OperatingSystem
  - withOperatingSystem
```
public Instance withOperatingSystem(OperatingSystem operatingSystem)
```
    Operating system that is running on this instance.
    
    Parameters:
    
    operatingSystem - Operating system that is running on this instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OperatingSystem
  - setType
```
public void setType(String type)
```
    EC2 instance type that defines the computing resources of this instance.
    
    Parameters:
    
    type - EC2 instance type that defines the computing resources of this instance.
    
    See Also:
    
    EC2InstanceType
  - getType
```
public String getType()
```
    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
  - withType
```
public Instance withType(String type)
```
    EC2 instance type that defines the computing resources of this instance.
    
    Parameters:
    
    type - EC2 instance type that defines the computing resources of this instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EC2InstanceType
  - setType
```
public void setType(EC2InstanceType type)
```
    EC2 instance type that defines the computing resources of this instance.
    
    Parameters:
    
    type - EC2 instance type that defines the computing resources of this instance.
    
    See Also:
    
    EC2InstanceType
  - withType
```
public Instance withType(EC2InstanceType type)
```
    EC2 instance type that defines the computing resources of this instance.
    
    Parameters:
    
    type - EC2 instance type that defines the computing resources of this instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EC2InstanceType
  - setStatus
```
public void setStatus(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 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.
    Parameters:
    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.
    See Also:
    
    InstanceStatus
  - getStatus
```
public String getStatus()
```
    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.
    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
  - withStatus
```
public Instance withStatus(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 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceStatus
  - setStatus
```
public void setStatus(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.
    Parameters:
    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.
    See Also:
    
    InstanceStatus
  - withStatus
```
public Instance withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceStatus
  - setCreationTime
```
public void setCreationTime(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").
    
    Parameters:
    
    creationTime - Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
  - getCreationTime
```
public Date getCreationTime()
```
    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").
  - withCreationTime
```
public Instance withCreationTime(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").
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Instance 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 Instance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Instance

Method Detail

setFleetId

getFleetId

withFleetId

setInstanceId

getInstanceId

withInstanceId

setIpAddress

getIpAddress

withIpAddress

setDnsName

getDnsName

withDnsName

setOperatingSystem

getOperatingSystem

withOperatingSystem

setOperatingSystem

withOperatingSystem

setType

getType

withType

setType

withType

setStatus

getStatus

withStatus

setStatus

withStatus

setCreationTime

getCreationTime

withCreationTime

toString

equals

hashCode

clone

marshall