class Aws::GameLift::Types::MatchmakingConfiguration

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/MatchmakingConfiguration AWS API Documentation
@return [String] : docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded match.
Amazon GameLift Servers queue to start a game session for the
* WITH_QUEUE - FlexMatch forms matches and uses the specified MatchmakingSucceeded] event.
information, including players and team assignments, in a [
* STANDALONE - FlexMatch forms matches and returns match
solution.
Amazon GameLift Servers hosting or as a standalone matchmaking
Indicates whether this matchmaking configuration is being used with
@!attribute [rw] flex_match_mode
@return [String] : docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html ‘FlexMatchMode` is set to `STANDALONE`. FlexMatch]. Automatic backfill is not available when
and automatic backfill in [Backfill existing games with
a game session has one or more open slots. Learn more about manual
AUTOMATIC indicates that GameLift creates backfill requests whenever
backfill requests or does not use the match backfill feature.
matchmaking configuration. MANUAL indicates that the game makes
The method used to backfill game sessions created with this
@!attribute [rw] backfill_mode
@return [String] : docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession parameter is not used when `FlexMatchMode` is set to `STANDALONE`.
`GameSession` object that is created for a successful match. This
[Start a game session]. This information is added to the new
request to start a new game session. For more information, see
string value. This data is passed to a game server process with a
A set of custom game session properties, formatted as a single
@!attribute [rw] game_session_data
@return [Array<Types::GameProperty>]
</note>
entries missing from SearchGameSessions API results.
If the limit is exceeded, there will potentially be game session
property keys across all game sessions and all fleets per region.
* If you use SearchGameSessions API, there is a limit of 500 game
due to search index limitations.
cannot be searched and will be filtered out from search results
for game sessions by properties. Property keys containing periods
<note markdown=“1”> * Avoid using periods (“.”) in property keys if you plan to search
`FlexMatchMode` is set to `STANDALONE`.
created for a successful match. This parameter is not used when
This information is added to the new `GameSession` object that is
session. For example: `{“Key”: “difficulty”, “Value”: “novice”}`.
A set of key-value pairs that can store custom data in a game
@!attribute [rw] game_properties
@return [Time]
`“1469498468.057”`).
a number expressed in Unix time as milliseconds (for example
A time stamp indicating when this data object was created. Format is
@!attribute [rw] creation_time
@return [String]
configuration.
Information to attach to all events related to the matchmaking
@!attribute [rw] custom_event_data
@return [Integer]
parameter is not used when `FlexMatchMode` is set to `STANDALONE`.
is set to 2, only 10 players are selected for the match. This
match for a single 12-person team, and the additional player count
players. For example, if the configuration’s rule set specifies a
The number of player slots in a match to keep open for future
@!attribute [rw] additional_player_count
@return [String]
notifications.
An SNS topic ARN that is set up to receive matchmaking
@!attribute [rw] notification_target
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html matchmaking rule set resource that this configuration uses.
The Amazon Resource Name ([ARN]) associated with the GameLift
@!attribute [rw] rule_set_arn
@return [String]
that are defined in the same Region.
configuration. A matchmaking configuration can only use rule sets
A unique identifier for the matchmaking rule set to use with this
@!attribute [rw] rule_set_name
@return [Boolean]
completed potential match is waiting for player acceptance.
tickets use the status ‘REQUIRES_ACCEPTANCE` to indicate when a
acceptance, set to TRUE. When this option is enabled, matchmaking
configuration must be accepted by the matched players. To require
A flag that indicates whether a match that was created with this
@!attribute [rw] acceptance_required
@return [Integer]
look for an acceptable match.
match or fails to accept before the timeout, the ticket continues to
proposed match, if acceptance is required. If any player rejects the
The length of time (in seconds) to wait for players to accept a
@!attribute [rw] acceptance_timeout_seconds
@return [Integer]
timing out can be resubmitted as needed.
remain in process before timing out. Requests that fail due to
The maximum duration, in seconds, that a matchmaking ticket can
@!attribute [rw] request_timeout_seconds
@return [Array<String>] : docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html `FlexMatchMode` is set to `STANDALONE`.
with this matchmaking configuration. This property is not set when
GameLift Servers-hosted game sessions for matches that are created
can be located in any Region. Queues are used to start new Amazon
`arn:aws:gamelift:<region>::gamesessionqueue/<queue name>`. Queues
it. ARNs are unique across all Regions. Format is
GameLift Servers game session queue resource and uniquely identifies
The Amazon Resource Name ([ARN]) that is assigned to a Amazon
@!attribute [rw] game_session_queue_arns
@return [String]
configuration.
A descriptive label that is associated with matchmaking
@!attribute [rw] description
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html ARN, the resource ID matches the Name value.
configuration name>`. In a Amazon GameLift Servers configuration
`arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking
identifies it. ARNs are unique across all Regions. Format is
GameLift Servers matchmaking configuration resource and uniquely
The Amazon Resource Name ([ARN]) that is assigned to a Amazon
@!attribute [rw] configuration_arn
@return [String]
request or ticket.
used to identify the configuration associated with a matchmaking
A unique identifier for the matchmaking configuration. This name is
@!attribute [rw] name
matchmaking requests must specify a matchmaking configuration.
Guidelines for use with FlexMatch to match players into games. All

class Aws::GameLift::Types::MatchmakingConfiguration

Namespace

Included Modules

Defined in