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 UpdateContainerFleet API operation.

Syntax

Update-GMLContainerFleet
-FleetId <String>
-Description <String>
-InstanceConnectionPortRange_FromPort <Int32>
-GameServerContainerGroupDefinitionName <String>
-GameServerContainerGroupsPerInstance <Int32>
-DeploymentConfiguration_ImpairmentStrategy <DeploymentImpairmentStrategy>
-InstanceInboundPermissionAuthorization <IpPermission[]>
-InstanceInboundPermissionRevocation <IpPermission[]>
-LogConfiguration_LogDestination <LogDestination>
-LogConfiguration_LogGroupArn <String>
-MetricGroup <String[]>
-DeploymentConfiguration_MinimumHealthyPercentage <Int32>
-NewGameSessionProtectionPolicy <ProtectionPolicy>
-GameSessionCreationLimitPolicy_NewGameSessionsPerCreator <Int32>
-PerInstanceContainerGroupDefinitionName <String>
-GameSessionCreationLimitPolicy_PolicyPeriodInMinute <Int32>
-DeploymentConfiguration_ProtectionStrategy <DeploymentProtectionStrategy>
-RemoveAttribute <String[]>
-LogConfiguration_S3BucketName <String>
-InstanceConnectionPortRange_ToPort <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonGameLiftConfig>

Description

This API works with the following fleet types: Container Updates the properties of a managed container fleet. Depending on the properties being updated, this operation might initiate a fleet deployment. You can track deployments for a fleet using https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetDeployment.html. A managed fleet's runtime environment, which depends on the fleet's Amazon Machine Image {AMI} version, can't be updated. You must create a new fleet. As a best practice, we recommend replacing your managed fleets every 30 days to maintain a secure and up-to-date runtime environment for your hosted game servers. For guidance, see Security best practices for Amazon GameLift Servers. Request options As with CreateContainerFleet, many fleet properties use common defaults or are calculated based on the fleet's container group definitions.
  • Update fleet properties that result in a fleet deployment. Include only those properties that you want to change. Specify deployment configuration settings.
  • Update fleet properties that don't result in a fleet deployment. Include only those properties that you want to change.
Changes to the following properties initiate a fleet deployment:
  • GameServerContainerGroupDefinition
  • PerInstanceContainerGroupDefinition
  • GameServerContainerGroupsPerInstance
  • InstanceInboundPermissions
  • InstanceConnectionPortRange
  • LogConfiguration
Results If successful, this operation updates the container fleet resource, and might initiate a new deployment of fleet resources using the deployment configuration provided. A deployment replaces existing fleet instances with new instances that are deployed with the updated fleet properties. The fleet is placed in UPDATING status until the deployment is complete, then return to ACTIVE. You can have only one update deployment active at a time for a fleet. If a second update request initiates a deployment while another deployment is in progress, the first deployment is cancelled.

Parameters

-ClientConfig <AmazonGameLiftConfig>
Amazon.PowerShell.Cmdlets.GML.AmazonGameLiftClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentConfiguration_ImpairmentStrategy <DeploymentImpairmentStrategy>
Determines what actions to take if a deployment fails. If the fleet is multi-location, this strategy applies across all fleet locations. With a rollback strategy, updated fleet instances are rolled back to the last successful deployment. Alternatively, you can maintain a few impaired containers for the purpose of debugging, while all other tasks return to the last successful deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentConfiguration_MinimumHealthyPercentage <Int32>
Sets a minimum level of healthy tasks to maintain during deployment activity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentConfiguration_ProtectionStrategy <DeploymentProtectionStrategy>
Determines how fleet deployment activity affects active game sessions on the fleet. With protection, a deployment honors game session protection, and delays actions that would interrupt a protected active game session until the game session ends. Without protection, deployment activity can shut down all running tasks, including active game sessions, regardless of game session protection.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A meaningful description of the container fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FleetId <String>
A unique identifier for the container fleet to update. You can use either the fleet ID or ARN value.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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)
-GameServerContainerGroupDefinitionName <String>
The name or ARN value of a new game server container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value. You can't remove a fleet's game server container group definition, you can only update or replace it with another definition.Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GameServerContainerGroupsPerInstance <Int32>
The number of times to replicate the game server container group on each fleet instance. By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. You can remove this property value to use the calculated value, or set it manually. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GameSessionCreationLimitPolicy_NewGameSessionsPerCreator <Int32>
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.The policy evaluates when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift Servers checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GameSessionCreationLimitPolicy_PolicyPeriodInMinute <Int32>
The time span used in evaluating the resource creation limit policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGameSessionCreationLimitPolicy_PolicyPeriodInMinutes
-InstanceConnectionPortRange_FromPort <Int32>
Starting value for the port range.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceConnectionPortRange_ToPort <Int32>
Ending value for the port. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceInboundPermissionAuthorization <IpPermission[]>
A set of ports to add to the container fleet's inbound permissions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceInboundPermissionAuthorizations
-InstanceInboundPermissionRevocation <IpPermission[]>
A set of ports to remove from the container fleet's inbound permissions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceInboundPermissionRevocations
-LogConfiguration_LogDestination <LogDestination>
The type of log collection to use for a fleet.
  • CLOUDWATCH -- (default value) Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.
  • S3 -- Store logs in an Amazon S3 bucket that you define. This bucket must reside in the fleet's home Amazon Web Services Region.
  • NONE -- Don't collect container logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogConfiguration_LogGroupArn <String>
If log destination is CLOUDWATCH, logs are sent to the specified log group in Amazon CloudWatch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogConfiguration_S3BucketName <String>
If log destination is S3, logs are sent to the specified Amazon S3 bucket name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricGroup <String[]>
The name of an Amazon Web Services CloudWatch metric group to add this fleet to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricGroups
-NewGameSessionProtectionPolicy <ProtectionPolicy>
The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the FleetId parameter. The -PassThru parameter is deprecated, use -Select '^FleetId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PerInstanceContainerGroupDefinitionName <String>
The name or ARN value of a new per-instance container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value.Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version. To remove a fleet's per-instance container group definition, leave this parameter empty and use the parameter RemoveAttributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RemoveAttribute <String[]>
If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRemoveAttributes
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ContainerFleet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateContainerFleetResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateContainerFleetResponse 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)

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.ContainerFleet or Amazon.GameLift.Model.UpdateContainerFleetResponse
This cmdlet returns an Amazon.GameLift.Model.ContainerFleet object. The service call response (type Amazon.GameLift.Model.UpdateContainerFleetResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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