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

Calls the Amazon GameLift Service CreateFleet API operation.

Syntax

New-GMLFleet
-BuildId <String>
-CertificateConfiguration_CertificateType <CertificateType>
-Description <String>
-EC2InboundPermission <IpPermission[]>
-EC2InstanceType <EC2InstanceType>
-FleetType <FleetType>
-RuntimeConfiguration_GameSessionActivationTimeoutSecond <Int32>
-InstanceRoleArn <String>
-Location <LocationConfiguration[]>
-LogPath <String[]>
-RuntimeConfiguration_MaxConcurrentGameSessionActivation <Int32>
-MetricGroup <String[]>
-Name <String>
-NewGameSessionProtectionPolicy <ProtectionPolicy>
-ResourceCreationLimitPolicy_NewGameSessionsPerCreator <Int32>
-PeerVpcAwsAccountId <String>
-PeerVpcId <String>
-ResourceCreationLimitPolicy_PolicyPeriodInMinute <Int32>
-ScriptId <String>
-ServerLaunchParameter <String>
-ServerLaunchPath <String>
-RuntimeConfiguration_ServerProcess <ServerProcess[]>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonGameLiftConfig>

Description

Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance. Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location. To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations. If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. If successful, this operation creates a new Fleet resource and places it in NEW status, which prompts GameLift to initiate the fleet creation workflow. You can track fleet creation by checking fleet status using DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by monitoring fleet creation events using DescribeFleetEvents. As soon as the fleet status changes to ACTIVE, you can enable automatic scaling for the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. When the status of each remote location reaches ACTIVE, you can set capacity by location using UpdateFleetCapacity. Learn moreSetting up fleetsDebug fleet creation issuesMulti-location fleetsRelated actionsCreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task

Parameters

-BuildId <String>
The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to GameLift and in READY status. This fleet property cannot be changed later.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-CertificateConfiguration_CertificateType <CertificateType>
Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values include:
  • GENERATED - Generate a TLS/SSL certificate for this fleet.
  • DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonGameLiftConfig>
Amazon.PowerShell.Cmdlets.GML.AmazonGameLiftClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A human-readable description of the fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EC2InboundPermission <IpPermission[]>
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEC2InboundPermissions
-EC2InstanceType <EC2InstanceType>
The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FleetType <FleetType>
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-InstanceRoleArn <String>
A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. This property cannot be changed after the fleet is created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Location <LocationConfiguration[]>
A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2. To create a fleet with instances in the home Region only, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLocations
-LogPath <String[]>
This parameter is no longer used. To specify where GameLift should store log files once a server process shuts down, use the 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?True (ByPropertyName)
AliasesLogPaths
-MetricGroup <String[]>
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricGroups
-Name <String>
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewGameSessionProtectionPolicy <ProtectionPolicy>
The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.
  • NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
  • FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the BuildId parameter. The -PassThru parameter is deprecated, use -Select '^BuildId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PeerVpcAwsAccountId <String>
Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PeerVpcId <String>
A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceCreationLimitPolicy_NewGameSessionsPerCreator <Int32>
The maximum number of game sessions that an individual can create during the policy period.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceCreationLimitPolicy_PolicyPeriodInMinute <Int32>
The time span used in evaluating the resource creation limit policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceCreationLimitPolicy_PolicyPeriodInMinutes
-RuntimeConfiguration_GameSessionActivationTimeoutSecond <Int32>
The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRuntimeConfiguration_GameSessionActivationTimeoutSeconds
-RuntimeConfiguration_MaxConcurrentGameSessionActivation <Int32>
The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRuntimeConfiguration_MaxConcurrentGameSessionActivations
-RuntimeConfiguration_ServerProcess <ServerProcess[]>
A collection of server process configurations that identify what server processes to run on each instance in a fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRuntimeConfiguration_ServerProcesses
-ScriptId <String>
The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'FleetAttributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.CreateFleetResponse). Specifying the name of a property of type Amazon.GameLift.Model.CreateFleetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerLaunchParameter <String>
This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesServerLaunchParameters
-ServerLaunchPath <String>
This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the fleet is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.GameLift.Model.FleetAttributes or Amazon.GameLift.Model.CreateFleetResponse
This cmdlet returns an Amazon.GameLift.Model.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.
AWS Tools for PowerShell User Guide

Supported Version

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