amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.Types.FleetUtilization

Description

 
Synopsis

Documentation

data FleetUtilization Source #

Current resource utilization statistics in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.

Related actions

See: newFleetUtilization smart constructor.

Constructors

FleetUtilization' 

Fields

  • activeGameSessionCount :: Maybe Natural

    The number of active game sessions that are currently being hosted across all instances in the fleet location.

  • activeServerProcessCount :: Maybe Natural

    The number of server processes in ACTIVE status that are currently running across all instances in the fleet location.

  • currentPlayerSessionCount :: Maybe Natural

    The number of active player sessions that are currently being hosted across all instances in the fleet location.

  • fleetArn :: Maybe Text

    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.

  • fleetId :: Maybe Text

    A unique identifier for the fleet associated with the location.

  • location :: Maybe Text

    The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as us-west-2.

  • maximumPlayerSessionCount :: Maybe Natural

    The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.

Instances

Instances details
FromJSON FleetUtilization Source # 
Instance details

Defined in Amazonka.GameLift.Types.FleetUtilization

Generic FleetUtilization Source # 
Instance details

Defined in Amazonka.GameLift.Types.FleetUtilization

Associated Types

type Rep FleetUtilization :: Type -> Type #

Read FleetUtilization Source # 
Instance details

Defined in Amazonka.GameLift.Types.FleetUtilization

Show FleetUtilization Source # 
Instance details

Defined in Amazonka.GameLift.Types.FleetUtilization

NFData FleetUtilization Source # 
Instance details

Defined in Amazonka.GameLift.Types.FleetUtilization

Methods

rnf :: FleetUtilization -> () #

Eq FleetUtilization Source # 
Instance details

Defined in Amazonka.GameLift.Types.FleetUtilization

Hashable FleetUtilization Source # 
Instance details

Defined in Amazonka.GameLift.Types.FleetUtilization

type Rep FleetUtilization Source # 
Instance details

Defined in Amazonka.GameLift.Types.FleetUtilization

type Rep FleetUtilization = D1 ('MetaData "FleetUtilization" "Amazonka.GameLift.Types.FleetUtilization" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "FleetUtilization'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "activeGameSessionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "activeServerProcessCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "currentPlayerSessionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "fleetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maximumPlayerSessionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newFleetUtilization :: FleetUtilization Source #

Create a value of FleetUtilization with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activeGameSessionCount:FleetUtilization', fleetUtilization_activeGameSessionCount - The number of active game sessions that are currently being hosted across all instances in the fleet location.

$sel:activeServerProcessCount:FleetUtilization', fleetUtilization_activeServerProcessCount - The number of server processes in ACTIVE status that are currently running across all instances in the fleet location.

$sel:currentPlayerSessionCount:FleetUtilization', fleetUtilization_currentPlayerSessionCount - The number of active player sessions that are currently being hosted across all instances in the fleet location.

$sel:fleetArn:FleetUtilization', fleetUtilization_fleetArn - 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.

$sel:fleetId:FleetUtilization', fleetUtilization_fleetId - A unique identifier for the fleet associated with the location.

$sel:location:FleetUtilization', fleetUtilization_location - The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as us-west-2.

$sel:maximumPlayerSessionCount:FleetUtilization', fleetUtilization_maximumPlayerSessionCount - The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.

fleetUtilization_activeGameSessionCount :: Lens' FleetUtilization (Maybe Natural) Source #

The number of active game sessions that are currently being hosted across all instances in the fleet location.

fleetUtilization_activeServerProcessCount :: Lens' FleetUtilization (Maybe Natural) Source #

The number of server processes in ACTIVE status that are currently running across all instances in the fleet location.

fleetUtilization_currentPlayerSessionCount :: Lens' FleetUtilization (Maybe Natural) Source #

The number of active player sessions that are currently being hosted across all instances in the fleet location.

fleetUtilization_fleetArn :: Lens' FleetUtilization (Maybe Text) Source #

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.

fleetUtilization_fleetId :: Lens' FleetUtilization (Maybe Text) Source #

A unique identifier for the fleet associated with the location.

fleetUtilization_location :: Lens' FleetUtilization (Maybe Text) Source #

The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as us-west-2.

fleetUtilization_maximumPlayerSessionCount :: Lens' FleetUtilization (Maybe Natural) Source #

The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.