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.

Container for the parameters to the GetInstanceAccess operation. Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call GetComputeAccess.

To request access to an instance, specify IDs for the instance and the fleet it belongs to. You can retrieve instance IDs for a fleet by calling DescribeInstances with the fleet ID.

If successful, this operation returns an IP address and credentials. The returned credentials match the operating system of the instance, as follows:

Learn more

Remotely connect to fleet instances

Debug fleet issues

Related actions

All APIs by task

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.GetInstanceAccessRequest

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

Syntax

C#
public class GetInstanceAccessRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The GetInstanceAccessRequest type exposes the following members

Constructors

NameDescription
Public Method GetInstanceAccessRequest()

Properties

NameTypeDescription
Public Property FleetId System.String

Gets and sets the property FleetId.

A unique identifier for the fleet that contains the instance you want to access. You can request access to instances in EC2 fleets with the following statuses: ACTIVATING, ACTIVE, or ERROR. Use either a fleet ID or an ARN value.

You can access fleets in ERROR status for a short period of time before Amazon GameLift deletes them.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

A unique identifier for the instance you want to access. You can access an instance in any status.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5