Struct aws_sdk_gamelift::operation::get_instance_access::builders::GetInstanceAccessFluentBuilder

pub struct GetInstanceAccessFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetInstanceAccess.

Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call 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

Implementations

impl GetInstanceAccessFluentBuilder

pub fn as_input(&self) -> &GetInstanceAccessInputBuilder

Access the GetInstanceAccess as a reference.

pub async fn send( self ) -> Result<GetInstanceAccessOutput, SdkError<GetInstanceAccessError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<GetInstanceAccessOutput, GetInstanceAccessError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

A unique identifier for the fleet that contains the instance you want to access. You can request access to instances in EC2 fleets with the following statuses: ACTIVATING, ACTIVE, or ERROR. Use either a fleet ID or an ARN value.

You can access fleets in ERROR status for a short period of time before Amazon GameLift deletes them.

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

A unique identifier for the fleet that contains the instance you want to access. You can request access to instances in EC2 fleets with the following statuses: ACTIVATING, ACTIVE, or ERROR. Use either a fleet ID or an ARN value.

You can access fleets in ERROR status for a short period of time before Amazon GameLift deletes them.

pub fn get_fleet_id(&self) -> &Option<String>

A unique identifier for the fleet that contains the instance you want to access. You can request access to instances in EC2 fleets with the following statuses: ACTIVATING, ACTIVE, or ERROR. Use either a fleet ID or an ARN value.

You can access fleets in ERROR status for a short period of time before Amazon GameLift deletes them.

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

A unique identifier for the instance you want to access. 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 access. You can access an instance in any status.

pub fn get_instance_id(&self) -> &Option<String>

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

Trait Implementations

impl Clone for GetInstanceAccessFluentBuilder

fn clone(&self) -> GetInstanceAccessFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetInstanceAccessFluentBuilder

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

Formats the value using the given formatter.