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

Syntax

Update-GMLMatchmakingConfiguration
-Name <String>
-AcceptanceRequired <Boolean>
-AcceptanceTimeoutSecond <Int32>
-AdditionalPlayerCount <Int32>
-BackfillMode <BackfillMode>
-CustomEventData <String>
-Description <String>
-FlexMatchMode <FlexMatchMode>
-GameProperty <GameProperty[]>
-GameSessionData <String>
-GameSessionQueueArn <String[]>
-NotificationTarget <String>
-RequestTimeoutSecond <Int32>
-RuleSetName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings. Learn more Design a FlexMatch matchmakerRelated actionsCreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task

Parameters

-AcceptanceRequired <Boolean>
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AcceptanceTimeoutSecond <Int32>
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAcceptanceTimeoutSeconds
-AdditionalPlayerCount <Int32>
The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to STANDALONE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BackfillMode <BackfillMode>
The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomEventData <String>
Information to add to all events related to the matchmaking configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A descriptive label that is associated with matchmaking configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FlexMatchMode <FlexMatchMode>
Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
  • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
  • WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match.
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)
-GameProperty <GameProperty[]>
A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGameProperties
-GameSessionData <String>
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GameSessionQueueArn <String[]>
The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGameSessionQueueArns
-Name <String>
A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-NotificationTarget <String>
An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequestTimeoutSecond <Int32>
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRequestTimeoutSeconds
-RuleSetName <String>
A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Configuration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateMatchmakingConfigurationResponse). Specifying the name of a property of type Amazon.GameLift.Model.UpdateMatchmakingConfigurationResponse 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.MatchmakingConfiguration or Amazon.GameLift.Model.UpdateMatchmakingConfigurationResponse
This cmdlet returns an Amazon.GameLift.Model.MatchmakingConfiguration object. The service call response (type Amazon.GameLift.Model.UpdateMatchmakingConfigurationResponse) 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