Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Class: Aws::GameLift::Types::Instance

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[:ip_address]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

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

Returns:

  • (Time) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#dns_name ⇒ String

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

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 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.

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#fleet_arn ⇒ 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:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#fleet_id ⇒ String

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

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#instance_id ⇒ String

A unique identifier for the instance.

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#ip_address ⇒ String

IP address that is assigned to the instance.

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#location ⇒ String

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

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#operating_system ⇒ String

Operating system that is running on this EC2 instance.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end

#type ⇒ String

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

Returns:

  • (String) 

7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 7469

class Instance < Struct.new(
  :fleet_id,
  :fleet_arn,
  :instance_id,
  :ip_address,
  :dns_name,
  :operating_system,
  :type,
  :status,
  :creation_time,
  :location)
  SENSITIVE = [:ip_address]
  include Aws::Structure
end