Struct aws_sdk_gamelift::types::Instance

#[non_exhaustive]
pub struct Instance {
    pub fleet_id: Option<String>,
    pub fleet_arn: Option<String>,
    pub instance_id: Option<String>,
    pub ip_address: Option<String>,
    pub dns_name: Option<String>,
    pub operating_system: Option<OperatingSystem>,
    pub type: Option<Ec2InstanceType>,
    pub status: Option<InstanceStatus>,
    pub creation_time: Option<DateTime>,
    pub location: Option<String>,
}

Represents a virtual computing instance that runs game server processes and hosts game sessions. In Amazon GameLift, one or more instances make up a managed EC2 fleet.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fleet_id: Option<String>

A unique identifier for the fleet that the instance belongs to.

fleet_arn: Option<String>

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .

instance_id: Option<String>

A unique identifier for the instance.

ip_address: Option<String>

IP address that is assigned to the instance.

dns_name: Option<String>

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: . .amazongamelift.com .

• Non-TLS-enabled fleets: ec2- .compute.amazonaws.com . (See Amazon Elastic Compute Cloud Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

operating_system: Option<OperatingSystem>

Operating system that is running on this EC2 instance.

type: Option<Ec2InstanceType>

EC2 instance type that defines the computing resources of this instance.

status: Option<InstanceStatus>

Current status of the instance. Possible statuses include the following:

• PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

• ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

• TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

creation_time: Option<DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

location: Option<String>

The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.

Implementations

impl Instance

pub fn fleet_id(&self) -> Option<&str>

A unique identifier for the fleet that the instance belongs to.

pub fn fleet_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .

pub fn instance_id(&self) -> Option<&str>

A unique identifier for the instance.

pub fn ip_address(&self) -> Option<&str>

IP address that is assigned to the instance.

pub fn dns_name(&self) -> Option<&str>

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

• TLS-enabled fleets: . .amazongamelift.com .

• Non-TLS-enabled fleets: ec2- .compute.amazonaws.com . (See Amazon Elastic Compute Cloud Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

pub fn operating_system(&self) -> Option<&OperatingSystem>

Operating system that is running on this EC2 instance.

pub fn type(&self) -> Option<&Ec2InstanceType>

EC2 instance type that defines the computing resources of this instance.

pub fn status(&self) -> Option<&InstanceStatus>

Current status of the instance. Possible statuses include the following:

• PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

• ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

• TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

pub fn creation_time(&self) -> Option<&DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn location(&self) -> Option<&str>

The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2.

impl Instance

pub fn builder() -> InstanceBuilder

Creates a new builder-style object to manufacture Instance.

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instance

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

Formats the value using the given formatter.

impl PartialEq for Instance

fn eq(&self, other: &Instance) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Instance