Class: Aws::GameLift::Types::UpdateMatchmakingConfigurationInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::UpdateMatchmakingConfigurationInput
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#acceptance_required ⇒ Boolean
A flag that indicates whether a match that was created with this configuration must be accepted by the matched players.
-
#acceptance_timeout_seconds ⇒ Integer
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
-
#additional_player_count ⇒ Integer
The number of player slots in a match to keep open for future players.
-
#backfill_mode ⇒ String
The method that is used to backfill game sessions created with this matchmaking configuration.
-
#custom_event_data ⇒ String
Information to add to all events related to the matchmaking configuration.
-
#description ⇒ String
A description for the matchmaking configuration.
-
#flex_match_mode ⇒ String
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
-
#game_properties ⇒ Array<Types::GameProperty>
A set of key-value pairs that can store custom data in a game session.
-
#game_session_data ⇒ String
A set of custom game session properties, formatted as a single string value.
-
#game_session_queue_arns ⇒ Array<String>
The Amazon Resource Name ([ARN][1]) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
-
#name ⇒ String
A unique identifier for the matchmaking configuration to update.
-
#notification_target ⇒ String
An SNS topic ARN that is set up to receive matchmaking notifications.
-
#request_timeout_seconds ⇒ Integer
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
-
#rule_set_name ⇒ String
A unique identifier for the matchmaking rule set to use with this configuration.
Instance Attribute Details
#acceptance_required ⇒ 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.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#acceptance_timeout_seconds ⇒ Integer
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#additional_player_count ⇒ Integer
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 10-person team, and the additional player count
is set to 2, 10 players will be selected for the match and 2 more
player slots will be open for future players. This parameter is not
used if FlexMatchMode
is set to STANDALONE
.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#backfill_mode ⇒ String
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 match backfill
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
.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#custom_event_data ⇒ String
Information to add to all events related to the matchmaking configuration.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description for the matchmaking configuration.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#flex_match_mode ⇒ String
Indicates whether this matchmaking configuration is being used with Amazon 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 Amazon GameLift queue to start a game session for the match.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#game_properties ⇒ Array<Types::GameProperty>
A set of key-value pairs that can store custom data in a game
session. For example: \{"Key": "difficulty", "Value": "novice"\}
.
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
.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#game_session_data ⇒ String
A set of custom game session properties, formatted as a single
string value. This data is passed to a game server process with a
request to start a new game session (see Start a Game Session).
This information is added to the game session that is created for a
successful match. This parameter is not used if FlexMatchMode
is
set to STANDALONE
.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#game_session_queue_arns ⇒ Array<String>
The Amazon Resource Name (ARN) that is assigned to a Amazon
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 Amazon
GameLift-hosted game sessions for matches that are created with this
matchmaking configuration. If FlexMatchMode
is set to
STANDALONE
, do not set this parameter.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#notification_target ⇒ String
An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#request_timeout_seconds ⇒ Integer
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.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |
#rule_set_name ⇒ 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.
9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9392 class UpdateMatchmakingConfigurationInput < Struct.new( :name, :description, :game_session_queue_arns, :request_timeout_seconds, :acceptance_timeout_seconds, :acceptance_required, :rule_set_name, :notification_target, :additional_player_count, :custom_event_data, :game_properties, :game_session_data, :backfill_mode, :flex_match_mode) SENSITIVE = [] include Aws::Structure end |