AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

General properties describing a fleet.

Fleet-related operations include:

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.FleetAttributes

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class FleetAttributes

The FleetAttributes type exposes the following members

Constructors

NameDescription
Public Method FleetAttributes()

Properties

NameTypeDescription
Public Property BuildId System.String

Gets and sets the property BuildId.

Unique identifier for a build.

Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

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

Public Property Description System.String

Gets and sets the property Description.

Human-readable description of the fleet.

Public Property FleetArn System.String

Gets and sets the property FleetArn.

Identifier for a fleet that is unique across all regions.

Public Property FleetId System.String

Gets and sets the property FleetId.

Unique identifier for a fleet.

Public Property LogPaths System.Collections.Generic.List<System.String>

Gets and sets the property LogPaths.

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.

Public Property MetricGroups System.Collections.Generic.List<System.String>

Gets and sets the property MetricGroups.

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.

Public Property Name System.String

Gets and sets the property Name.

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

Public Property NewGameSessionProtectionPolicy Amazon.GameLift.ProtectionPolicy

Gets and sets the property NewGameSessionProtectionPolicy.

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.

Public Property OperatingSystem Amazon.GameLift.OperatingSystem

Gets and sets the property OperatingSystem.

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.

Public Property ResourceCreationLimitPolicy Amazon.GameLift.Model.ResourceCreationLimitPolicy

Gets and sets the property ResourceCreationLimitPolicy.

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

Public Property ServerLaunchParameters System.String

Gets and sets the property ServerLaunchParameters.

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.

Public Property ServerLaunchPath System.String

Gets and sets the property ServerLaunchPath.

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.

Public Property Status Amazon.GameLift.FleetStatus

Gets and sets the property Status.

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.

Public Property TerminationTime System.DateTime

Gets and sets the property TerminationTime.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms