instance_access

Creates, updates, deletes, gets or lists an instance_access resource.

Overview

Name	instance_access
Type	Resource
Id	aws.gamelift.instance_access

Fields

The following fields are returned by SELECT queries:

get_instance_access

Name	Datatype	Description
credentials	object	Security credentials that are required to access the instance.
fleet_id	string	A unique identifier for the fleet containing the instance to be accessed. (pattern: <code>^[a-z]*fleet-[a-zA-Z0-9-]+$</code>)
instance_id	string	A unique identifier for the instance to be accessed. (pattern: <code>^[a-zA-Z0-9.-]+$</code>)
ip_address	string	IP address assigned to the instance. (pattern: <code>^[0-9A-Fa-f:.]+$</code>)
operating_system	string	Operating system that is running on the instance. (WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023, WINDOWS_2022)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_instance_access	select	region		This API works with the following fleet types: EC2 Requests authorization to remotely connect to an instance in an Amazon GameLift Servers managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift Servers server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call https:​//docs.aws.amazon.com/gamelift/latest/apireference/API_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: For a Windows instance: returns a user name and secret (password) for use with a Windows Remote Desktop client. For a Linux instance: returns a user name and secret (RSA private key) for use with an SSH client. You must save the secret to a .pem file. If you're using the CLI, see the example Get credentials for a Linux instance for tips on automatically saving the secret to a .pem file. Learn more Remotely connect to fleet instances Debug fleet issues Related actions All APIs by task

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_instance_access

This API works with the following fleet types: EC2 Requests authorization to remotely connect to an instance in an Amazon GameLift Servers managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift Servers server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call https://docs.aws.amazon.com/gamelift/latest/apireference/API_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: For a Windows instance: returns a user name and secret (password) for use with a Windows Remote Desktop client. For a Linux instance: returns a user name and secret (RSA private key) for use with an SSH client. You must save the secret to a .pem file. If you're using the CLI, see the example Get credentials for a Linux instance for tips on automatically saving the secret to a .pem file. Learn more Remotely connect to fleet instances Debug fleet issues Related actions All APIs by task

SELECT
credentials,
fleet_id,
instance_id,
ip_address,
operating_system
FROM aws.gamelift.instance_access
WHERE region = '{{ region }}' -- required
;