/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace GameLift { namespace Model { /** *

Guidelines for use with FlexMatch to match players into games. All * matchmaking requests must specify a matchmaking configuration.

See * Also:

AWS * API Reference

*/ class MatchmakingConfiguration { public: AWS_GAMELIFT_API MatchmakingConfiguration(); AWS_GAMELIFT_API MatchmakingConfiguration(Aws::Utils::Json::JsonView jsonValue); AWS_GAMELIFT_API MatchmakingConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_GAMELIFT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

A unique identifier for the matchmaking configuration. This name is used to * identify the configuration associated with a matchmaking request or ticket.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

A unique identifier for the matchmaking configuration. This name is used to * identify the configuration associated with a matchmaking request or ticket.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

A unique identifier for the matchmaking configuration. This name is used to * identify the configuration associated with a matchmaking request or ticket.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

A unique identifier for the matchmaking configuration. This name is used to * identify the configuration associated with a matchmaking request or ticket.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

A unique identifier for the matchmaking configuration. This name is used to * identify the configuration associated with a matchmaking request or ticket.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

A unique identifier for the matchmaking configuration. This name is used to * identify the configuration associated with a matchmaking request or ticket.

*/ inline MatchmakingConfiguration& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

A unique identifier for the matchmaking configuration. This name is used to * identify the configuration associated with a matchmaking request or ticket.

*/ inline MatchmakingConfiguration& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

A unique identifier for the matchmaking configuration. This name is used to * identify the configuration associated with a matchmaking request or ticket.

*/ inline MatchmakingConfiguration& WithName(const char* value) { SetName(value); return *this;} /** *

The Amazon Resource Name (ARN) * that is assigned to a Amazon GameLift matchmaking configuration resource and * uniquely identifies it. ARNs are unique across all Regions. Format is * arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking * configuration name>. In a Amazon GameLift configuration ARN, the * resource ID matches the Name value.

*/ inline const Aws::String& GetConfigurationArn() const{ return m_configurationArn; } /** *

*/ inline bool ConfigurationArnHasBeenSet() const { return m_configurationArnHasBeenSet; } /** *

*/ inline void SetConfigurationArn(const Aws::String& value) { m_configurationArnHasBeenSet = true; m_configurationArn = value; } /** *

*/ inline void SetConfigurationArn(Aws::String&& value) { m_configurationArnHasBeenSet = true; m_configurationArn = std::move(value); } /** *

*/ inline void SetConfigurationArn(const char* value) { m_configurationArnHasBeenSet = true; m_configurationArn.assign(value); } /** *

*/ inline MatchmakingConfiguration& WithConfigurationArn(const Aws::String& value) { SetConfigurationArn(value); return *this;} /** *

*/ inline MatchmakingConfiguration& WithConfigurationArn(Aws::String&& value) { SetConfigurationArn(std::move(value)); return *this;} /** *

*/ inline MatchmakingConfiguration& WithConfigurationArn(const char* value) { SetConfigurationArn(value); return *this;} /** *

A descriptive label that is associated with matchmaking configuration.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A descriptive label that is associated with matchmaking configuration.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A descriptive label that is associated with matchmaking configuration.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A descriptive label that is associated with matchmaking configuration.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A descriptive label that is associated with matchmaking configuration.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A descriptive label that is associated with matchmaking configuration.

*/ inline MatchmakingConfiguration& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A descriptive label that is associated with matchmaking configuration.

*/ inline MatchmakingConfiguration& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A descriptive label that is associated with matchmaking configuration.

*/ inline MatchmakingConfiguration& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

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. This property is not set when * FlexMatchMode is set to STANDALONE.

*/ inline const Aws::Vector& GetGameSessionQueueArns() const{ return m_gameSessionQueueArns; } /** *

*/ inline bool GameSessionQueueArnsHasBeenSet() const { return m_gameSessionQueueArnsHasBeenSet; } /** *

*/ inline void SetGameSessionQueueArns(const Aws::Vector& value) { m_gameSessionQueueArnsHasBeenSet = true; m_gameSessionQueueArns = value; } /** *

*/ inline void SetGameSessionQueueArns(Aws::Vector&& value) { m_gameSessionQueueArnsHasBeenSet = true; m_gameSessionQueueArns = std::move(value); } /** *

*/ inline MatchmakingConfiguration& WithGameSessionQueueArns(const Aws::Vector& value) { SetGameSessionQueueArns(value); return *this;} /** *

*/ inline MatchmakingConfiguration& WithGameSessionQueueArns(Aws::Vector&& value) { SetGameSessionQueueArns(std::move(value)); return *this;} /** *

*/ inline MatchmakingConfiguration& AddGameSessionQueueArns(const Aws::String& value) { m_gameSessionQueueArnsHasBeenSet = true; m_gameSessionQueueArns.push_back(value); return *this; } /** *

*/ inline MatchmakingConfiguration& AddGameSessionQueueArns(Aws::String&& value) { m_gameSessionQueueArnsHasBeenSet = true; m_gameSessionQueueArns.push_back(std::move(value)); return *this; } /** *

*/ inline MatchmakingConfiguration& AddGameSessionQueueArns(const char* value) { m_gameSessionQueueArnsHasBeenSet = true; m_gameSessionQueueArns.push_back(value); return *this; } /** *

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.

*/ inline int GetRequestTimeoutSeconds() const{ return m_requestTimeoutSeconds; } /** *

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.

*/ inline bool RequestTimeoutSecondsHasBeenSet() const { return m_requestTimeoutSecondsHasBeenSet; } /** *

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.

*/ inline void SetRequestTimeoutSeconds(int value) { m_requestTimeoutSecondsHasBeenSet = true; m_requestTimeoutSeconds = value; } /** *

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.

*/ inline MatchmakingConfiguration& WithRequestTimeoutSeconds(int value) { SetRequestTimeoutSeconds(value); return *this;} /** *

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

*/ inline int GetAcceptanceTimeoutSeconds() const{ return m_acceptanceTimeoutSeconds; } /** *

*/ inline bool AcceptanceTimeoutSecondsHasBeenSet() const { return m_acceptanceTimeoutSecondsHasBeenSet; } /** *

*/ inline void SetAcceptanceTimeoutSeconds(int value) { m_acceptanceTimeoutSecondsHasBeenSet = true; m_acceptanceTimeoutSeconds = value; } /** *

*/ inline MatchmakingConfiguration& WithAcceptanceTimeoutSeconds(int value) { SetAcceptanceTimeoutSeconds(value); return *this;} /** *

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. When this option is enabled, matchmaking tickets use the status * REQUIRES_ACCEPTANCE to indicate when a completed potential match is * waiting for player acceptance.

*/ inline bool GetAcceptanceRequired() const{ return m_acceptanceRequired; } /** *

*/ inline bool AcceptanceRequiredHasBeenSet() const { return m_acceptanceRequiredHasBeenSet; } /** *

*/ inline void SetAcceptanceRequired(bool value) { m_acceptanceRequiredHasBeenSet = true; m_acceptanceRequired = value; } /** *

*/ inline MatchmakingConfiguration& WithAcceptanceRequired(bool value) { SetAcceptanceRequired(value); return *this;} /** *

A unique identifier for the matchmaking rule set to use with this * configuration. A matchmaking configuration can only use rule sets that are * defined in the same Region.

*/ inline const Aws::String& GetRuleSetName() const{ return m_ruleSetName; } /** *

A unique identifier for the matchmaking rule set to use with this * configuration. A matchmaking configuration can only use rule sets that are * defined in the same Region.

*/ inline bool RuleSetNameHasBeenSet() const { return m_ruleSetNameHasBeenSet; } /** *

A unique identifier for the matchmaking rule set to use with this * configuration. A matchmaking configuration can only use rule sets that are * defined in the same Region.

*/ inline void SetRuleSetName(const Aws::String& value) { m_ruleSetNameHasBeenSet = true; m_ruleSetName = value; } /** *

A unique identifier for the matchmaking rule set to use with this * configuration. A matchmaking configuration can only use rule sets that are * defined in the same Region.

*/ inline void SetRuleSetName(Aws::String&& value) { m_ruleSetNameHasBeenSet = true; m_ruleSetName = std::move(value); } /** *

A unique identifier for the matchmaking rule set to use with this * configuration. A matchmaking configuration can only use rule sets that are * defined in the same Region.

*/ inline void SetRuleSetName(const char* value) { m_ruleSetNameHasBeenSet = true; m_ruleSetName.assign(value); } /** *

A unique identifier for the matchmaking rule set to use with this * configuration. A matchmaking configuration can only use rule sets that are * defined in the same Region.

*/ inline MatchmakingConfiguration& WithRuleSetName(const Aws::String& value) { SetRuleSetName(value); return *this;} /** *

A unique identifier for the matchmaking rule set to use with this * configuration. A matchmaking configuration can only use rule sets that are * defined in the same Region.

*/ inline MatchmakingConfiguration& WithRuleSetName(Aws::String&& value) { SetRuleSetName(std::move(value)); return *this;} /** *

A unique identifier for the matchmaking rule set to use with this * configuration. A matchmaking configuration can only use rule sets that are * defined in the same Region.

*/ inline MatchmakingConfiguration& WithRuleSetName(const char* value) { SetRuleSetName(value); return *this;} /** *

The Amazon Resource Name (ARN) * associated with the GameLift matchmaking rule set resource that this * configuration uses.

*/ inline const Aws::String& GetRuleSetArn() const{ return m_ruleSetArn; } /** *

The Amazon Resource Name (ARN) * associated with the GameLift matchmaking rule set resource that this * configuration uses.

*/ inline bool RuleSetArnHasBeenSet() const { return m_ruleSetArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) * associated with the GameLift matchmaking rule set resource that this * configuration uses.

*/ inline void SetRuleSetArn(const Aws::String& value) { m_ruleSetArnHasBeenSet = true; m_ruleSetArn = value; } /** *

The Amazon Resource Name (ARN) * associated with the GameLift matchmaking rule set resource that this * configuration uses.

*/ inline void SetRuleSetArn(Aws::String&& value) { m_ruleSetArnHasBeenSet = true; m_ruleSetArn = std::move(value); } /** *

The Amazon Resource Name (ARN) * associated with the GameLift matchmaking rule set resource that this * configuration uses.

*/ inline void SetRuleSetArn(const char* value) { m_ruleSetArnHasBeenSet = true; m_ruleSetArn.assign(value); } /** *

The Amazon Resource Name (ARN) * associated with the GameLift matchmaking rule set resource that this * configuration uses.

*/ inline MatchmakingConfiguration& WithRuleSetArn(const Aws::String& value) { SetRuleSetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) * associated with the GameLift matchmaking rule set resource that this * configuration uses.

*/ inline MatchmakingConfiguration& WithRuleSetArn(Aws::String&& value) { SetRuleSetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) * associated with the GameLift matchmaking rule set resource that this * configuration uses.

*/ inline MatchmakingConfiguration& WithRuleSetArn(const char* value) { SetRuleSetArn(value); return *this;} /** *

An SNS topic ARN that is set up to receive matchmaking notifications.

*/ inline const Aws::String& GetNotificationTarget() const{ return m_notificationTarget; } /** *

An SNS topic ARN that is set up to receive matchmaking notifications.

*/ inline bool NotificationTargetHasBeenSet() const { return m_notificationTargetHasBeenSet; } /** *

An SNS topic ARN that is set up to receive matchmaking notifications.

*/ inline void SetNotificationTarget(const Aws::String& value) { m_notificationTargetHasBeenSet = true; m_notificationTarget = value; } /** *

An SNS topic ARN that is set up to receive matchmaking notifications.

*/ inline void SetNotificationTarget(Aws::String&& value) { m_notificationTargetHasBeenSet = true; m_notificationTarget = std::move(value); } /** *

An SNS topic ARN that is set up to receive matchmaking notifications.

*/ inline void SetNotificationTarget(const char* value) { m_notificationTargetHasBeenSet = true; m_notificationTarget.assign(value); } /** *

An SNS topic ARN that is set up to receive matchmaking notifications.

*/ inline MatchmakingConfiguration& WithNotificationTarget(const Aws::String& value) { SetNotificationTarget(value); return *this;} /** *

An SNS topic ARN that is set up to receive matchmaking notifications.

*/ inline MatchmakingConfiguration& WithNotificationTarget(Aws::String&& value) { SetNotificationTarget(std::move(value)); return *this;} /** *

An SNS topic ARN that is set up to receive matchmaking notifications.

*/ inline MatchmakingConfiguration& WithNotificationTarget(const char* value) { SetNotificationTarget(value); return *this;} /** *

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 when FlexMatchMode is set to * STANDALONE.

*/ inline int GetAdditionalPlayerCount() const{ return m_additionalPlayerCount; } /** *

*/ inline bool AdditionalPlayerCountHasBeenSet() const { return m_additionalPlayerCountHasBeenSet; } /** *

*/ inline void SetAdditionalPlayerCount(int value) { m_additionalPlayerCountHasBeenSet = true; m_additionalPlayerCount = value; } /** *

*/ inline MatchmakingConfiguration& WithAdditionalPlayerCount(int value) { SetAdditionalPlayerCount(value); return *this;} /** *