compute_access
Creates, updates, deletes, gets or lists a compute_access resource.
Overview
| Name | compute_access |
| Type | Resource |
| Id | aws.gamelift.compute_access |
Fields
The following fields are returned by SELECT queries:
- get_compute_access
| Name | Datatype | Description |
|---|---|---|
compute_arn | string | The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift Servers compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. (pattern: <code>^arn:.*:compute/[a-zA-Z0-9-]+(/[a-zA-Z0-9-]+)?$</code>) |
compute_name | string | The identifier of the compute resource to be accessed. This value might be either a compute name or an instance ID. (pattern: <code>^([a-zA-Z0-9-]+(/[a-zA-Z0-9-]+)?|arn:.*:compute/[a-zA-Z0-9-]+(/[a-zA-Z0-9-]+)?)$</code>) |
container_identifiers | array | For a managed container fleet, a list of containers on the compute. Use the container runtime ID with Docker commands to connect to a specific container. |
credentials | object | A set of temporary Amazon Web Services credentials for use when connecting to the compute resource with Amazon EC2 Systems Manager (SSM). |
fleet_arn | string | The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. (pattern: <code>^arn:.*:[a-z]*fleet/[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
fleet_id | string | The ID of the fleet that holds the compute resource to be accessed. (pattern: <code>^[a-z]fleet-[a-zA-Z0-9-]+$|^arn:.:[a-z]*fleet/[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
target | string | The instance ID where the compute resource is running. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_compute_access | select | region | This API works with the following fleet types: EC2, Container Requests authorization to remotely connect to a hosting resource in a Amazon GameLift Servers managed fleet. This operation is not used with Amazon GameLift Servers Anywhere fleets. Request options Provide the fleet ID and compute name. The compute name varies depending on the type of fleet. For a compute in a managed EC2 fleet, provide an instance ID. Each instance in the fleet is a compute. For a compute in a managed container fleet, provide a compute name. In a container fleet, each game server container group on a fleet instance is assigned a compute name. Results If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token. With a managed EC2 fleet (where compute type is EC2), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide. |
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_compute_access
This API works with the following fleet types: EC2, Container Requests authorization to remotely connect to a hosting resource in a Amazon GameLift Servers managed fleet. This operation is not used with Amazon GameLift Servers Anywhere fleets. Request options Provide the fleet ID and compute name. The compute name varies depending on the type of fleet. For a compute in a managed EC2 fleet, provide an instance ID. Each instance in the fleet is a compute. For a compute in a managed container fleet, provide a compute name. In a container fleet, each game server container group on a fleet instance is assigned a compute name. Results If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token. With a managed EC2 fleet (where compute type is EC2), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.
SELECT
compute_arn,
compute_name,
container_identifiers,
credentials,
fleet_arn,
fleet_id,
target
FROM aws.gamelift.compute_access
WHERE region = '{{ region }}' -- required
;