aws_sdk_gamelift/client/
get_compute_access.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetComputeAccess`](crate::operation::get_compute_access::builders::GetComputeAccessFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`fleet_id(impl Into<String>)`](crate::operation::get_compute_access::builders::GetComputeAccessFluentBuilder::fleet_id) / [`set_fleet_id(Option<String>)`](crate::operation::get_compute_access::builders::GetComputeAccessFluentBuilder::set_fleet_id):<br>required: **true**<br><p>A unique identifier for the fleet that holds the compute resource that you want to connect to. You can use either the fleet ID or ARN value.</p><br>
7    ///   - [`compute_name(impl Into<String>)`](crate::operation::get_compute_access::builders::GetComputeAccessFluentBuilder::compute_name) / [`set_compute_name(Option<String>)`](crate::operation::get_compute_access::builders::GetComputeAccessFluentBuilder::set_compute_name):<br>required: **true**<br><p>A unique identifier for the compute resource that you want to connect to. For an EC2 fleet, use an instance ID. For a managed container fleet, use a compute name. You can retrieve a fleet's compute names by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute.html">ListCompute</a>.</p><br>
8    /// - On success, responds with [`GetComputeAccessOutput`](crate::operation::get_compute_access::GetComputeAccessOutput) with field(s):
9    ///   - [`fleet_id(Option<String>)`](crate::operation::get_compute_access::GetComputeAccessOutput::fleet_id): <p>The ID of the fleet that holds the compute resource to be accessed.</p>
10    ///   - [`fleet_arn(Option<String>)`](crate::operation::get_compute_access::GetComputeAccessOutput::fleet_arn): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>    ::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912   </region></code>.</p>
11    ///   - [`compute_name(Option<String>)`](crate::operation::get_compute_access::GetComputeAccessOutput::compute_name): <p>The identifier of the compute resource to be accessed. This value might be either a compute name or an instance ID.</p>
12    ///   - [`compute_arn(Option<String>)`](crate::operation::get_compute_access::GetComputeAccessOutput::compute_arn): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to an Amazon GameLift Servers compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>    ::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912   </region></code>.</p>
13    ///   - [`credentials(Option<AwsCredentials>)`](crate::operation::get_compute_access::GetComputeAccessOutput::credentials): <p>A set of temporary Amazon Web Services credentials for use when connecting to the compute resource with Amazon EC2 Systems Manager (SSM).</p>
14    ///   - [`target(Option<String>)`](crate::operation::get_compute_access::GetComputeAccessOutput::target): <p>The instance ID where the compute resource is running.</p>
15    ///   - [`container_identifiers(Option<Vec::<ContainerIdentifier>>)`](crate::operation::get_compute_access::GetComputeAccessOutput::container_identifiers): <p>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.</p>
16    /// - On failure, responds with [`SdkError<GetComputeAccessError>`](crate::operation::get_compute_access::GetComputeAccessError)
17    pub fn get_compute_access(&self) -> crate::operation::get_compute_access::builders::GetComputeAccessFluentBuilder {
18        crate::operation::get_compute_access::builders::GetComputeAccessFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_gamelift/client/get_compute_access.rs

aws_sdk_gamelift/client/
get_compute_access.rs
