Network.AWS.GameLift.CreateFleet

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the ACTIVE status, it can begin hosting game sessions.

To create a new fleet, provide a fleet name, an EC2 instance type, and a build ID of the game build to deploy. You can also configure the new fleet with the following settings: (1) a runtime configuration describing what server processes to run on each instance in the fleet (required to create fleet), (2) access permissions for inbound traffic, (3) fleet-wide game session protection, and (4) the location of default log files for GameLift to upload and store.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks:

• Creates a fleet record and sets the status to NEW (followed by other statuses as the fleet is activated).
• Sets the fleet's capacity to 1 "desired", which causes GameLift to start one new EC2 instance.
• Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, GameLift staggers each launch by a few seconds.
• Begins writing events to the fleet event log, which can be accessed in the GameLift console.
• Sets the fleet's status to ACTIVE once one server process in the fleet is ready to host a game session.

After a fleet is created, use the following actions to change fleet properties and configuration:

• UpdateFleetAttributes -- Update fleet metadata, including name and description.
• UpdateFleetCapacity -- Increase or decrease the number of instances you want the fleet to maintain.
• UpdateFleetPortSettings -- Change the IP address and port ranges that allow access to incoming traffic.
• UpdateRuntimeConfiguration -- Change how server processes are launched in the fleet, including launch path, launch parameters, and the number of concurrent processes.

Creating a Request

createFleet

Arguments

:: Text

cfName

-> Text

cfBuildId

-> EC2InstanceType

cfEC2InstanceType

-> CreateFleet

Creates a value of CreateFleet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cfServerLaunchParameters
• cfLogPaths
• cfEC2InboundPermissions
• cfRuntimeConfiguration
• cfNewGameSessionProtectionPolicy
• cfServerLaunchPath
• cfDescription
• cfName
• cfBuildId
• cfEC2InstanceType

data CreateFleet

Represents the input for a request action.

See: createFleet smart constructor.

Instances

Eq CreateFleet

Methods

(==) :: CreateFleet -> CreateFleet -> Bool

(/=) :: CreateFleet -> CreateFleet -> Bool

Data CreateFleet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateFleet -> c CreateFleet

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateFleet

toConstr :: CreateFleet -> Constr

dataTypeOf :: CreateFleet -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateFleet)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateFleet)

gmapT :: (forall b. Data b => b -> b) -> CreateFleet -> CreateFleet

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateFleet -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateFleet -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateFleet -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateFleet -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateFleet -> m CreateFleet

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateFleet -> m CreateFleet

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateFleet -> m CreateFleet

Read CreateFleet

Methods

readsPrec :: Int -> ReadS CreateFleet

readList :: ReadS [CreateFleet]

readPrec :: ReadPrec CreateFleet

readListPrec :: ReadPrec [CreateFleet]

Show CreateFleet

Methods

showsPrec :: Int -> CreateFleet -> ShowS

show :: CreateFleet -> String

showList :: [CreateFleet] -> ShowS

Generic CreateFleet

Associated Types

type Rep CreateFleet :: * -> *

Methods

from :: CreateFleet -> Rep CreateFleet x

to :: Rep CreateFleet x -> CreateFleet

Hashable CreateFleet

Methods

hashWithSalt :: Int -> CreateFleet -> Int

hash :: CreateFleet -> Int

NFData CreateFleet

Methods

rnf :: CreateFleet -> ()

AWSRequest CreateFleet

Associated Types

type Rs CreateFleet :: *

Methods

request :: CreateFleet -> Request CreateFleet

response :: MonadResource m => Logger -> Service -> Proxy * CreateFleet -> ClientResponse -> m (Response CreateFleet)

ToPath CreateFleet

Methods

toPath :: CreateFleet -> ByteString

ToHeaders CreateFleet

Methods

toHeaders :: CreateFleet -> [Header]

ToQuery CreateFleet

Methods

toQuery :: CreateFleet -> QueryString

ToJSON CreateFleet

Methods

toJSON :: CreateFleet -> Value

toEncoding :: CreateFleet -> Encoding

type Rep CreateFleet

type Rep CreateFleet = D1 (MetaData "CreateFleet" "Network.AWS.GameLift.CreateFleet" "amazonka-gamelift-1.4.4-DPfJmtllByT7OdD35vBDe5" False) (C1 (MetaCons "CreateFleet'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cfServerLaunchParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cfLogPaths") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_cfEC2InboundPermissions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [IPPermission]))) ((:*:) (S1 (MetaSel (Just Symbol "_cfRuntimeConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RuntimeConfiguration))) (S1 (MetaSel (Just Symbol "_cfNewGameSessionProtectionPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProtectionPolicy)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cfServerLaunchPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cfDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cfName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_cfBuildId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cfEC2InstanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 EC2InstanceType)))))))

type Rs CreateFleet

type Rs CreateFleet = CreateFleetResponse

Request Lenses

cfServerLaunchParameters :: Lens' CreateFleet (Maybe Text)

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)

cfLogPaths :: Lens' CreateFleet [Text]

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, GameLift will automatically upload logs stored on each instance at 'C:\\game\\logs'. Use the GameLift console to access stored logs.

cfEC2InboundPermissions :: Lens' CreateFleet [IPPermission]

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

cfRuntimeConfiguration :: Lens' CreateFleet (Maybe RuntimeConfiguration)

Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a runtime configuration with at least one server process configuration; otherwise the request will fail with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a runtime configuration will continue to work.)

cfNewGameSessionProtectionPolicy :: Lens' CreateFleet (Maybe ProtectionPolicy)

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

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

cfServerLaunchPath :: Lens' CreateFleet (Maybe Text)

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)

cfDescription :: Lens' CreateFleet (Maybe Text)

Human-readable description of a fleet.

cfName :: Lens' CreateFleet Text

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

cfBuildId :: Lens' CreateFleet Text

Unique identifier of the build to be deployed on the new fleet. The build must have been successfully uploaded to GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

cfEC2InstanceType :: Lens' CreateFleet EC2InstanceType

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Destructuring the Response

createFleetResponse

Arguments

:: Int

cfrsResponseStatus

-> CreateFleetResponse

Creates a value of CreateFleetResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cfrsFleetAttributes
• cfrsResponseStatus

data CreateFleetResponse

Represents the returned data in response to a request action.

See: createFleetResponse smart constructor.

Instances

Eq CreateFleetResponse

Methods

(==) :: CreateFleetResponse -> CreateFleetResponse -> Bool

(/=) :: CreateFleetResponse -> CreateFleetResponse -> Bool

Data CreateFleetResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateFleetResponse -> c CreateFleetResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateFleetResponse

toConstr :: CreateFleetResponse -> Constr

dataTypeOf :: CreateFleetResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateFleetResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateFleetResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateFleetResponse -> CreateFleetResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateFleetResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateFleetResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateFleetResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateFleetResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateFleetResponse -> m CreateFleetResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateFleetResponse -> m CreateFleetResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateFleetResponse -> m CreateFleetResponse

Read CreateFleetResponse

Methods

readsPrec :: Int -> ReadS CreateFleetResponse

readList :: ReadS [CreateFleetResponse]

readPrec :: ReadPrec CreateFleetResponse

readListPrec :: ReadPrec [CreateFleetResponse]

Show CreateFleetResponse

Methods

showsPrec :: Int -> CreateFleetResponse -> ShowS

show :: CreateFleetResponse -> String

showList :: [CreateFleetResponse] -> ShowS

Generic CreateFleetResponse

Associated Types

type Rep CreateFleetResponse :: * -> *

Methods

from :: CreateFleetResponse -> Rep CreateFleetResponse x

to :: Rep CreateFleetResponse x -> CreateFleetResponse

NFData CreateFleetResponse

Methods

rnf :: CreateFleetResponse -> ()

type Rep CreateFleetResponse

type Rep CreateFleetResponse = D1 (MetaData "CreateFleetResponse" "Network.AWS.GameLift.CreateFleet" "amazonka-gamelift-1.4.4-DPfJmtllByT7OdD35vBDe5" False) (C1 (MetaCons "CreateFleetResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cfrsFleetAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FleetAttributes))) (S1 (MetaSel (Just Symbol "_cfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cfrsFleetAttributes :: Lens' CreateFleetResponse (Maybe FleetAttributes)

Properties for the newly created fleet.

cfrsResponseStatus :: Lens' CreateFleetResponse Int

The response status code.