InstanceAccess - Amazon GameLift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

InstanceAccess

Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess.

Contents

Note

In the following list, the required parameters are described first.

Credentials

Credentials required to access the instance.

Type: InstanceCredentials object

Required: No

FleetId

A unique identifier for the fleet containing the instance being accessed.

Type: String

Pattern: ^fleet-\S+

Required: No

InstanceId

A unique identifier for the instance being accessed.

Type: String

Pattern: [a-zA-Z0-9\.-]+

Required: No

IpAddress

IP address that is assigned to the instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$

Required: No

OperatingSystem

Operating system that is running on the instance.

Type: String

Valid Values: WINDOWS_2012 | AMAZON_LINUX | AMAZON_LINUX_2

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: