/ 
Paws-0.40
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::GameLift::UpdateMatchmakingConfiguration

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                     => 'MyMatchmakingIdStringModel',
  AcceptanceRequired       => 1,                              # OPTIONAL
  AcceptanceTimeoutSeconds => 1,                              # OPTIONAL
  AdditionalPlayerCount    => 1,                              # 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           => 'MyMatchmakingIdStringModel',    # 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

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

AcceptanceTimeoutSeconds => Int

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

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.

CustomEventData => Str

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

Description => Str

Descriptive label that is associated with matchmaking configuration.

GameProperties => ArrayRef[Paws::GameLift::GameProperty]

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

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/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. 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

Unique identifier for a matchmaking configuration to update.

NotificationTarget => Str

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

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

RuleSetName => Str

Unique identifier for a matchmaking rule set to use with this configuration. 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