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
- Struct
- Aws::GameLift::Types::FleetAttributes
- Defined in:
- (unknown)
Overview
General properties describing a fleet.
Returned by:
Instance Attribute Summary collapse
-
#build_arn ⇒ String
The Amazon Resource Name ([ARN][1]) associated with the GameLift build resource that is deployed on instances in this fleet.
-
#build_id ⇒ String
A unique identifier for a build.
-
#certificate_configuration ⇒ Types::CertificateConfiguration
Indicates whether a TLS/SSL certificate was generated for the fleet.
-
#creation_time ⇒ Time
Time stamp indicating when this data object was created.
-
#description ⇒ String
Human-readable description of the fleet.
-
#fleet_arn ⇒ String
The Amazon Resource Name ([ARN][1]) that is assigned to a GameLift fleet resource and uniquely identifies it.
-
#fleet_id ⇒ String
A unique identifier for a fleet.
-
#fleet_type ⇒ String
Indicates whether the fleet uses on-demand or spot instances.
-
#instance_role_arn ⇒ String
A unique identifier for an AWS IAM role that manages access to your AWS services.
-
#instance_type ⇒ String
EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity.
-
#log_paths ⇒ Array<String>
Location of default log files.
-
#metric_groups ⇒ Array<String>
Names of metric groups that this fleet is included in.
-
#name ⇒ String
A descriptive label that is associated with a fleet.
-
#new_game_session_protection_policy ⇒ String
The type of game session protection to set for all new instances started in the fleet.
-
#operating_system ⇒ String
Operating system of the fleet\'s computing resources.
-
#resource_creation_limit_policy ⇒ Types::ResourceCreationLimitPolicy
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
-
#script_arn ⇒ String
The Amazon Resource Name ([ARN][1]) associated with the GameLift script resource that is deployed on instances in this fleet.
-
#script_id ⇒ String
A unique identifier for a Realtime script.
-
#server_launch_parameters ⇒ String
Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16).
-
#server_launch_path ⇒ 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).
-
#status ⇒ String
Current status of the fleet.
-
#stopped_actions ⇒ Array<String>
List of fleet activity that have been suspended using StopFleetActions.
-
#termination_time ⇒ Time
Time stamp indicating when this data object was terminated.
Instance Attribute Details
#build_arn ⇒ String
The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.
#build_id ⇒ String
A unique identifier for a build.
#certificate_configuration ⇒ Types::CertificateConfiguration
Indicates whether a TLS/SSL certificate was generated for the fleet.
#creation_time ⇒ Time
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
#description ⇒ String
Human-readable description of the fleet.
#fleet_arn ⇒ String
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.
#fleet_id ⇒ String
A unique identifier for a fleet.
#fleet_type ⇒ String
Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.
Possible values:
- ON_DEMAND
- SPOT
#instance_role_arn ⇒ String
A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role\'s ARN from the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
#instance_type ⇒ String
EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.
#log_paths ⇒ Array<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.
#metric_groups ⇒ Array<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.
#name ⇒ String
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
#new_game_session_protection_policy ⇒ String
The 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
#operating_system ⇒ String
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
- AMAZON_LINUX_2
#resource_creation_limit_policy ⇒ Types::ResourceCreationLimitPolicy
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
#script_arn ⇒ String
The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.
#script_id ⇒ String
A unique identifier for a Realtime script.
#server_launch_parameters ⇒ String
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.
#server_launch_path ⇒ 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). Server launch paths for fleets created after this date are specified in the fleet\'s RuntimeConfiguration.
#status ⇒ String
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 or Realtime script 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
#stopped_actions ⇒ Array<String>
List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.
#termination_time ⇒ Time
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").