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 set up a fleet to use instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy your game build to run on each instance.

To create a new fleet, you must specify the following: (1) a fleet name, (2) the build ID of a successfully uploaded game build, (3) an EC2 instance type, and (4) a run-time configuration, which describes the server processes to run on each instance in the fleet. If you don't specify a fleet type (on-demand or spot), the new fleet uses on-demand instances by default.

You can also configure the new fleet with the following settings:

• Fleet description
• Access permissions for inbound traffic
• Fleet-wide game session protection
• Resource usage limits
• VPC peering connection (see VPC Peering with Amazon GameLift Fleets )

If you use Amazon CloudWatch for metrics, you can add the new fleet to a metric group. By adding multiple fleets to a metric group, you can view aggregated metrics for all the fleets in the group.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:

• Creates a fleet record. Status: NEW .
• Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.

Sets the fleet's target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance.

• Downloads the game build to the new instance and installs it. Statuses: DOWNLOADING , VALIDATING , BUILDING .
• Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each launch by a few seconds. Status: ACTIVATING .
• Sets the fleet's status to ACTIVE as soon as one server process is ready to host a game session.

Fleet-related operations include:

• CreateFleet
• ListFleets
• DeleteFleet
• Describe fleets:
• DescribeFleetAttributes
• DescribeFleetCapacity
• DescribeFleetPortSettings
• DescribeFleetUtilization
• DescribeRuntimeConfiguration
• DescribeEC2InstanceLimits
• DescribeFleetEvents
• Update fleets:
• UpdateFleetAttributes
• UpdateFleetCapacity
• UpdateFleetPortSettings
• UpdateRuntimeConfiguration
• Manage fleet actions:
• StartFleetActions
• StopFleetActions

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 - 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 run-time configuration will continue to work.)
• cfLogPaths - This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters . See more information in the Server API Reference .
• cfPeerVPCId - Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.
• cfFleetType - Indicates whether to use on-demand instances or spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations, based on the instance type selected for this fleet. You can acquire on-demand instances at any time for a fixed price and keep them as long as you need them. Spot instances have lower prices, but spot pricing is variable, and while in use they can be interrupted (with a two-minute notification). Learn more about Amazon GameLift spot instances with at Choose Computing Resources .
• cfPeerVPCAWSAccountId - Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.
• cfEC2InboundPermissions - 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 - Instructions for launching server processes on each instance in the fleet. The run-time 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 run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters ; requests that contain values for these parameters instead of a run-time configuration will continue to work.)
• cfNewGameSessionProtectionPolicy - 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 - 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 run-time configuration will continue to work.)
• cfMetricGroups - Name of a metric group to add this fleet to. A metric group tracks metrics across all fleets in the group. Use an existing metric group name to add this fleet to the group, or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.
• cfDescription - Human-readable description of a fleet.
• cfResourceCreationLimitPolicy - Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
• cfName - Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
• cfBuildId - Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
• cfEC2InstanceType - 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. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

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

ToJSON CreateFleet

Methods

toJSON :: CreateFleet -> Value

toEncoding :: CreateFleet -> Encoding

toJSONList :: [CreateFleet] -> Value

toEncodingList :: [CreateFleet] -> Encoding

NFData CreateFleet

Methods

rnf :: CreateFleet -> ()

AWSRequest CreateFleet

Associated Types

type Rs CreateFleet :: *

Methods

request :: CreateFleet -> Request CreateFleet

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

ToHeaders CreateFleet

Methods

toHeaders :: CreateFleet -> [Header]

ToPath CreateFleet

Methods

toPath :: CreateFleet -> ByteString

ToQuery CreateFleet

Methods

toQuery :: CreateFleet -> QueryString

type Rep CreateFleet

type Rep CreateFleet = D1 * (MetaData "CreateFleet" "Network.AWS.GameLift.CreateFleet" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" 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 "_cfPeerVPCId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cfFleetType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe FleetType))) (S1 * (MetaSel (Just Symbol "_cfPeerVPCAWSAccountId") 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 "_cfMetricGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_cfDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cfResourceCreationLimitPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ResourceCreationLimitPolicy))) (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 run-time configuration will continue to work.)

cfLogPaths :: Lens' CreateFleet [Text]

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters . See more information in the Server API Reference .

cfPeerVPCId :: Lens' CreateFleet (Maybe Text)

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

cfFleetType :: Lens' CreateFleet (Maybe FleetType)

Indicates whether to use on-demand instances or spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations, based on the instance type selected for this fleet. You can acquire on-demand instances at any time for a fixed price and keep them as long as you need them. Spot instances have lower prices, but spot pricing is variable, and while in use they can be interrupted (with a two-minute notification). Learn more about Amazon GameLift spot instances with at Choose Computing Resources .

cfPeerVPCAWSAccountId :: Lens' CreateFleet (Maybe Text)

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

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 run-time 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 run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters ; requests that contain values for these parameters instead of a run-time 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 run-time configuration will continue to work.)

cfMetricGroups :: Lens' CreateFleet [Text]

Name of a metric group to add this fleet to. A metric group tracks metrics across all fleets in the group. Use an existing metric group name to add this fleet to the group, or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

cfDescription :: Lens' CreateFleet (Maybe Text)

Human-readable description of a fleet.

cfResourceCreationLimitPolicy :: Lens' CreateFleet (Maybe ResourceCreationLimitPolicy)

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

cfName :: Lens' CreateFleet Text

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

cfBuildId :: Lens' CreateFleet Text

Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon 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. Amazon 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 - Properties for the newly created fleet.
• cfrsResponseStatus - -- | The response status code.

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.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "CreateFleetResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cfrsFleetAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe FleetAttributes))) (S1 * (MetaSel (Just Symbol "_cfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cfrsFleetAttributes :: Lens' CreateFleetResponse (Maybe FleetAttributes)

Properties for the newly created fleet.

cfrsResponseStatus :: Lens' CreateFleetResponse Int

• - | The response status code.