Struct aws_sdk_gamelift::client::fluent_builders::GetInstanceAccess

pub struct GetInstanceAccess<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetInstanceAccess.

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned that contains the instance's IP address and a set of credentials.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related actions

DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task

Implementations

impl<C, M, R> GetInstanceAccess<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetInstanceAccessOutput, SdkError<GetInstanceAccessError>> where
    R::Policy: SmithyRetryPolicy<GetInstanceAccessInputOperationOutputAlias, GetInstanceAccessOutput, GetInstanceAccessError, GetInstanceAccessInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn fleet_id(self, inp: impl Into<String>) -> Self

A unique identifier for the fleet that contains the instance you want access to. You can use either the fleet ID or ARN value. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted.

pub fn set_fleet_id(self, input: Option<String>) -> Self

A unique identifier for the fleet that contains the instance you want access to. You can use either the fleet ID or ARN value. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted.

pub fn instance_id(self, inp: impl Into<String>) -> Self

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

pub fn set_instance_id(self, input: Option<String>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for GetInstanceAccess<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.