You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::FleetAttributes

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#build_idString

Unique identifier for a build.

Returns:

  • (String)

    Unique identifier for a build.

#creation_timeTime

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)

    Time stamp indicating when this data object was created.

#descriptionString

Human-readable description of the fleet.

Returns:

  • (String)

    Human-readable description of the fleet.

#fleet_arnString

Identifier for a fleet that is unique across all regions.

Returns:

  • (String)

    Identifier for a fleet that is unique across all regions.

#fleet_idString

Unique identifier for a fleet.

Returns:

  • (String)

    Unique identifier for a fleet.

#log_pathsArray<String>

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Returns:

  • (Array<String>)

    Location of default log files.

#metric_groupsArray<String>

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Returns:

  • (Array<String>)

    Names of metric groups that this fleet is included in.

#nameString

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Returns:

  • (String)

    Descriptive label that is associated with a fleet.

#new_game_session_protection_policyString

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

    Possible values:

    • NoProtection
    • FullProtection

Returns:

  • (String)

    Type of game session protection to set for all new instances started in the fleet.

#operating_systemString

Operating system of the fleet\'s computing resources. A fleet\'s operating system depends on the OS specified for the build that is deployed on this fleet.

Possible values:

  • WINDOWS_2012
  • AMAZON_LINUX

Returns:

  • (String)

    Operating system of the fleet\'s computing resources.

#resource_creation_limit_policyTypes::ResourceCreationLimitPolicy

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Returns:

#server_launch_parametersString

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet\'s RuntimeConfiguration.

Returns:

  • (String)

    Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16).

#server_launch_pathString

Path to a game server executable in the fleet\'s build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet\'s RuntimeConfiguration.

Returns:

  • (String)

    Path to a game server executable in the fleet\'s build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16).

#statusString

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW -- A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.

  • ACTIVE -- Hosts can now accept game sessions.

  • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING -- Hosts are responding to a delete fleet request.

  • TERMINATED -- The fleet no longer exists.

    Possible values:

    • NEW
    • DOWNLOADING
    • VALIDATING
    • BUILDING
    • ACTIVATING
    • ACTIVE
    • DELETING
    • ERROR
    • TERMINATED

Returns:

  • (String)

    Current status of the fleet.

#termination_timeTime

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

Returns:

  • (Time)

    Time stamp indicating when this data object was terminated.