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

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

Overview

Represents an EC2 instance of virtual computing resources that hosts one or more game servers. In GameLift, a fleet can contain zero or more instances.

Related actions

DescribeInstances

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

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)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#dns_nameString

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)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#fleet_arnString

The Amazon Resource Name (ARN) that is assigned to a 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)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#fleet_idString

A unique identifier for the fleet that the instance is in.

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#instance_idString

A unique identifier for the instance.

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#ip_addressString

IP address that is assigned to the instance.

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#locationString

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

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#operating_systemString

Operating system that is running on this instance.

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#statusString

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 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)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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

#typeString

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

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5931

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