Package software.amazon.awscdk.services.gamelift

Interface CfnMatchmakingConfigurationProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnMatchmakingConfigurationProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.908Z") @Stability(Stable) public interface CfnMatchmakingConfigurationProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnMatchmakingConfiguration.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 CfnMatchmakingConfigurationProps cfnMatchmakingConfigurationProps = CfnMatchmakingConfigurationProps.builder()
         .acceptanceRequired(false)
         .name("name")
         .requestTimeoutSeconds(123)
         .ruleSetName("ruleSetName")
         // the properties below are optional
         .acceptanceTimeoutSeconds(123)
         .additionalPlayerCount(123)
         .backfillMode("backfillMode")
         .customEventData("customEventData")
         .description("description")
         .flexMatchMode("flexMatchMode")
         .gameProperties(List.of(GamePropertyProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .gameSessionData("gameSessionData")
         .gameSessionQueueArns(List.of("gameSessionQueueArns"))
         .notificationTarget("notificationTarget")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getAcceptanceRequired

      @Stability(Stable) @NotNull Object getAcceptanceRequired()
      A flag that determines 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.

    • getName

      @Stability(Stable) @NotNull String getName()
      A unique identifier for the matchmaking configuration.

      This name is used to identify the configuration associated with a matchmaking request or ticket.

    • getRequestTimeoutSeconds

      @Stability(Stable) @NotNull Number getRequestTimeoutSeconds()
      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.

    • getRuleSetName

      @Stability(Stable) @NotNull String getRuleSetName()
      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.

    • getAcceptanceTimeoutSeconds

      @Stability(Stable) @Nullable default Number getAcceptanceTimeoutSeconds()
      The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

    • getAdditionalPlayerCount

      @Stability(Stable) @Nullable default Number getAdditionalPlayerCount()
      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 .

    • getBackfillMode

      @Stability(Stable) @Nullable default String getBackfillMode()
      The method used to backfill game sessions that are 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 . Automatic backfill is not available when FlexMatchMode is set to STANDALONE .

    • getCustomEventData

      @Stability(Stable) @Nullable default String getCustomEventData()
      Information to add to all events related to the matchmaking configuration.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description for the matchmaking configuration.

    • getFlexMatchMode

      @Stability(Stable) @Nullable default String getFlexMatchMode()
      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.

    • getGameProperties

      @Stability(Stable) @Nullable default Object getGameProperties()
      A set of custom properties for a game session, formatted as key-value pairs.

      These properties are passed to a game server process with a request to start a new game session. See Start a Game Session . This parameter is not used if FlexMatchMode is set to STANDALONE .

    • getGameSessionData

      @Stability(Stable) @Nullable default String getGameSessionData()
      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 parameter is not used if FlexMatchMode is set to STANDALONE .

    • getGameSessionQueueArns

      @Stability(Stable) @Nullable default List<String> getGameSessionQueueArns()
      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.

    • getNotificationTarget

      @Stability(Stable) @Nullable default String getNotificationTarget()
      An SNS topic ARN that is set up to receive matchmaking notifications.

      See Setting up notifications for matchmaking for more information.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      A list of labels to assign to the new matchmaking configuration resource.

      Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

    • builder

      @Stability(Stable) static CfnMatchmakingConfigurationProps.Builder builder()
      Returns:
      a CfnMatchmakingConfigurationProps.Builder of CfnMatchmakingConfigurationProps