Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.Types.GameServerInstance

Description

Documentation

data GameServerInstance Source #

__This data type is used with the GameLift FleetIQ and game server groups.__

Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see DescribeGameServerGroup and with the EC2 launch template that was used when creating the game server group.

Retrieve game server instances for a game server group by calling DescribeGameServerInstances.

See: newGameServerInstance smart constructor.

Constructors

GameServerInstance'

Fields

gameServerGroupArn :: Maybe Text
A generated unique identifier for the game server group that includes the game server instance.
gameServerGroupName :: Maybe Text
A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.
instanceId :: Maybe Text
The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.
instanceStatus :: Maybe GameServerInstanceStatus
Current status of the game server instance

Instances

Instances details

FromJSON GameServerInstance Source #
Instance details Defined in Amazonka.GameLift.Types.GameServerInstance Methods parseJSON :: Value -> Parser GameServerInstance # parseJSONList :: Value -> Parser [GameServerInstance] #
Generic GameServerInstance Source #
Instance details Defined in Amazonka.GameLift.Types.GameServerInstance Associated Types type Rep GameServerInstance :: Type -> Type # Methods from :: GameServerInstance -> Rep GameServerInstance x # to :: Rep GameServerInstance x -> GameServerInstance #
Read GameServerInstance Source #
Instance details Defined in Amazonka.GameLift.Types.GameServerInstance Methods readsPrec :: Int -> ReadS GameServerInstance # readList :: ReadS [GameServerInstance] # readPrec :: ReadPrec GameServerInstance # readListPrec :: ReadPrec [GameServerInstance] #
Show GameServerInstance Source #
Instance details Defined in Amazonka.GameLift.Types.GameServerInstance Methods showsPrec :: Int -> GameServerInstance -> ShowS # show :: GameServerInstance -> String # showList :: [GameServerInstance] -> ShowS #
NFData GameServerInstance Source #
Instance details Defined in Amazonka.GameLift.Types.GameServerInstance Methods rnf :: GameServerInstance -> () #
Eq GameServerInstance Source #
Instance details Defined in Amazonka.GameLift.Types.GameServerInstance Methods (==) :: GameServerInstance -> GameServerInstance -> Bool # (/=) :: GameServerInstance -> GameServerInstance -> Bool #
Hashable GameServerInstance Source #
Instance details Defined in Amazonka.GameLift.Types.GameServerInstance Methods hashWithSalt :: Int -> GameServerInstance -> Int # hash :: GameServerInstance -> Int #
type Rep GameServerInstance Source #
Instance details Defined in Amazonka.GameLift.Types.GameServerInstance type Rep GameServerInstance = D1 ('MetaData "GameServerInstance" "Amazonka.GameLift.Types.GameServerInstance" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "GameServerInstance'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gameServerGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gameServerGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameServerInstanceStatus)))))

newGameServerInstance :: GameServerInstance Source #

Create a value of GameServerInstance 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:gameServerGroupArn:GameServerInstance', gameServerInstance_gameServerGroupArn - A generated unique identifier for the game server group that includes the game server instance.

$sel:gameServerGroupName:GameServerInstance', gameServerInstance_gameServerGroupName - A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.

$sel:instanceId:GameServerInstance', gameServerInstance_instanceId - The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

$sel:instanceStatus:GameServerInstance', gameServerInstance_instanceStatus - Current status of the game server instance

gameServerInstance_gameServerGroupArn :: Lens' GameServerInstance (Maybe Text) Source #

A generated unique identifier for the game server group that includes the game server instance.

gameServerInstance_gameServerGroupName :: Lens' GameServerInstance (Maybe Text) Source #

A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.

gameServerInstance_instanceId :: Lens' GameServerInstance (Maybe Text) Source #

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

gameServerInstance_instanceStatus :: Lens' GameServerInstance (Maybe GameServerInstanceStatus) Source #

Current status of the game server instance