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

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

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

Overview

General properties describing a fleet.

Fleet-related operations include:

  • CreateFleet

  • ListFleets

  • Describe fleets:

    • DescribeFleetAttributes

    • DescribeFleetPortSettings

    • DescribeFleetUtilization

    • DescribeRuntimeConfiguration

    • DescribeFleetEvents

  • Update fleets:

    • UpdateFleetAttributes

    • UpdateFleetCapacity

    • UpdateFleetPortSettings

    • UpdateRuntimeConfiguration

  • Manage fleet capacity:

    • DescribeFleetCapacity

    • UpdateFleetCapacity

    • PutScalingPolicy (automatic scaling)

    • DescribeScalingPolicies (automatic scaling)

    • DeleteScalingPolicy (automatic scaling)

    • DescribeEC2InstanceLimits

  • DeleteFleet

Instance Attribute Summary collapse

Instance Attribute Details

#build_idString

Unique identifier for a build.

Returns:

  • (String)


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

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


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

#descriptionString

Human-readable description of the fleet.

Returns:

  • (String)


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

#fleet_arnString

Identifier for a fleet that is unique across all regions.

Returns:

  • (String)


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

#fleet_idString

Unique identifier for a fleet.

Returns:

  • (String)


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

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


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

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


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

#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.

Returns:

  • (String)


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

#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.

Returns:

  • (String)


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

#resource_creation_limit_policyTypes::ResourceCreationLimitPolicy

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



2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

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


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

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


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

#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.

Returns:

  • (String)


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end

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


2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2981

class FleetAttributes < Struct.new(
  :fleet_id,
  :fleet_arn,
  :description,
  :name,
  :creation_time,
  :termination_time,
  :status,
  :build_id,
  :server_launch_path,
  :server_launch_parameters,
  :log_paths,
  :new_game_session_protection_policy,
  :operating_system,
  :resource_creation_limit_policy,
  :metric_groups)
  include Aws::Structure
end