InstanceAccess - Amazon GameLift
ContentsSee Also
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 (PDF).

InstanceAccess

Information and credentials that you can use to remotely connect to an instance in an EC2 managed fleet. This data type is returned in response to a call to GetInstanceAccess.

Contents

Note

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

Credentials

Security credentials that are required to access the instance.

Type: InstanceCredentials object

Required: No

FleetId

A unique identifier for the fleet containing the instance to be accessed.

Type: String

Pattern: ^fleet-\S+

Required: No

InstanceId

A unique identifier for the instance to be accessed.

Type: String

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

Required: No

IpAddress

IP address assigned to the instance.

Type: String

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

Pattern: ^[0-9A-Fa-f\:\.]+

Required: No

OperatingSystem

Operating system that is running on the instance.

Type: String

Valid Values: WINDOWS_2012 | AMAZON_LINUX | AMAZON_LINUX_2 | WINDOWS_2016 | AMAZON_LINUX_2023

Required: No

See Also

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