AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.Instance

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class Instance

The Instance type exposes the following members

Constructors

NameDescription
Public Method Instance()

Properties

NameTypeDescription
Public Property CreationTime System.DateTime

Gets and sets the property 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").

Public Property DnsName System.String

Gets and sets the property DnsName.

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

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

Public Property FleetArn System.String

Gets and sets the property 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:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Public Property FleetId System.String

Gets and sets the property FleetId.

A unique identifier for the fleet that the instance belongs to.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

A unique identifier for the instance.

Public Property IpAddress System.String

Gets and sets the property IpAddress.

IP address that is assigned to the instance.

Public Property Location System.String

Gets and sets the property Location.

The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.

Public Property OperatingSystem Amazon.GameLift.OperatingSystem

Gets and sets the property OperatingSystem.

Operating system that is running on this EC2 instance.

Public Property Status Amazon.GameLift.InstanceStatus

Gets and sets the property 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.

Public Property Type Amazon.GameLift.EC2InstanceType

Gets and sets the property Type.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5