AWS Tools for Windows PowerShell
Command 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.

Synopsis

Invokes the CreateFleet operation against Amazon GameLift Service.

Syntax

New-GMLFleet
-BuildId <String>
-Description <String>
-EC2InboundPermission <IpPermission[]>
-EC2InstanceType <EC2InstanceType>
-RuntimeConfiguration_GameSessionActivationTimeoutSecond <Int32>
-LogPath <String[]>
-RuntimeConfiguration_MaxConcurrentGameSessionActivation <Int32>
-MetricGroup <String[]>
-Name <String>
-NewGameSessionProtectionPolicy <ProtectionPolicy>
-ResourceCreationLimitPolicy_NewGameSessionsPerCreator <Int32>
-ResourceCreationLimitPolicy_PolicyPeriodInMinute <Int32>
-ServerLaunchParameter <String>
-ServerLaunchPath <String>
-RuntimeConfiguration_ServerProcess <ServerProcess[]>
-Force <SwitchParameter>

Description

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, you must specify the following: (1) fleet name, (2) build ID of an uploaded game build, (3) an EC2 instance type, and (4) a run-time configuration that describes which server processes to run on each instance in the fleet. (Although the run-time configuration is not a required parameter, the fleet cannot be successfully activated without it.) You can also configure the new fleet with the following settings:
  • Fleet description
  • Access permissions for inbound traffic
  • Fleet-wide game session protection
  • Resource creation limit
If you use Amazon CloudWatch for metrics, you can add the new fleet to a metric group. This allows you to view aggregated metrics for a set of fleets. Once you specify a metric group, the new fleet's metrics are included in the metric group's data. 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 target capacity to 1 (desired instances), which causes Amazon 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, Amazon GameLift staggers each launch by a few seconds.
  • Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.
  • Sets the fleet's status to ACTIVE as soon as one server process in the fleet is ready to host a game session.
Fleet-related operations include:

Parameters

-BuildId <String>
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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Description <String>
Human-readable description of a fleet.
Required?False
Position?Named
Accept pipeline input?False
-EC2InboundPermission <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.
Required?False
Position?Named
Accept pipeline input?False
-EC2InstanceType <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.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-LogPath <String[]>
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.
Required?False
Position?Named
Accept pipeline input?False
-MetricGroup <String[]>
Names of metric groups to add this fleet to. 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.
Required?False
Position?Named
Accept pipeline input?False
-Name <String>
Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewGameSessionProtectionPolicy <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.
Required?False
Position?Named
Accept pipeline input?False
-ResourceCreationLimitPolicy_NewGameSessionsPerCreator <Int32>
Maximum number of game sessions that an individual can create during the policy period.
Required?False
Position?Named
Accept pipeline input?False
-ResourceCreationLimitPolicy_PolicyPeriodInMinute <Int32>
Time span used in evaluating the resource creation limit policy.
Required?False
Position?Named
Accept pipeline input?False
-RuntimeConfiguration_GameSessionActivationTimeoutSecond <Int32>
Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
Required?False
Position?Named
Accept pipeline input?False
-RuntimeConfiguration_MaxConcurrentGameSessionActivation <Int32>
Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
Required?False
Position?Named
Accept pipeline input?False
-RuntimeConfiguration_ServerProcess <ServerProcess[]>
Collection of server process configurations that describe which server processes to run on each instance in a fleet.
Required?False
Position?Named
Accept pipeline input?False
-ServerLaunchParameter <String>
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.)
Required?False
Position?Named
Accept pipeline input?False
-ServerLaunchPath <String>
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.)
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the BuildId parameter.

Outputs

This cmdlet returns a FleetAttributes object. The service call response (type Amazon.GameLift.Model.CreateFleetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z