NAME

Paws::GameLift::UpdateMatchmakingConfiguration - Arguments for method UpdateMatchmakingConfiguration on Paws::GameLift

DESCRIPTION

This class represents the parameters used for calling the method UpdateMatchmakingConfiguration on the Amazon GameLift service. Use the attributes of this class as arguments to method UpdateMatchmakingConfiguration.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateMatchmakingConfiguration.

SYNOPSIS

my $gamelift = Paws->service('GameLift');
my $UpdateMatchmakingConfigurationOutput =
  $gamelift->UpdateMatchmakingConfiguration(
  Name                     => 'MyMatchmakingConfigurationName',
  AcceptanceRequired       => 1,                                  # OPTIONAL
  AcceptanceTimeoutSeconds => 1,                                  # OPTIONAL
  AdditionalPlayerCount    => 1,                                  # OPTIONAL
  BackfillMode             => 'AUTOMATIC',                        # OPTIONAL
  CustomEventData          => 'MyCustomEventData',                # OPTIONAL
  Description              => 'MyNonZeroAndMaxString',            # OPTIONAL
  GameProperties           => [
    {
      Key   => 'MyGamePropertyKey',      # max: 32
      Value => 'MyGamePropertyValue',    # max: 96

    },
    ...
  ],    # OPTIONAL
  GameSessionData      => 'MyGameSessionData',    # OPTIONAL
  GameSessionQueueArns => [
    'MyArnStringModel', ...                       # min: 1, max: 256
  ],    # OPTIONAL
  NotificationTarget    => 'MySnsArnStringModel',         # OPTIONAL
  RequestTimeoutSeconds => 1,                             # OPTIONAL
  RuleSetName           => 'MyMatchmakingRuleSetName',    # OPTIONAL
  );

# Results:
my $Configuration = $UpdateMatchmakingConfigurationOutput->Configuration;

# Returns a L<Paws::GameLift::UpdateMatchmakingConfigurationOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/gamelift/UpdateMatchmakingConfiguration

ATTRIBUTES

AcceptanceRequired => Bool

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.

AcceptanceTimeoutSeconds => Int

The length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

AdditionalPlayerCount => Int

The number of player slots in a match to keep open for future players. For example, assume that the configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to 2, only 10 players are initially selected for the match.

BackfillMode => Str

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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html).

Valid values are: "AUTOMATIC", "MANUAL"

CustomEventData => Str

Information to add to all events related to the matchmaking configuration.

Description => Str

A descriptive label that is associated with matchmaking configuration.

GameProperties => ArrayRef[Paws::GameLift::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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). This information is added to the new GameSession object that is created for a successful match.

GameSessionData => Str

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 (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). This information is added to the new GameSession object that is created for a successful match.

GameSessionQueueArns => ArrayRef[Str|Undef]

Amazon Resource Name (ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any Region.

REQUIRED Name => Str

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

NotificationTarget => Str

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html) for more information.

RequestTimeoutSeconds => Int

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.

RuleSetName => Str

A unique identifier for a 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateMatchmakingConfiguration in Paws::GameLift

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues