Package software.amazon.awscdk.services.gamelift

Class CfnMatchmakingConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.gamelift.CfnMatchmakingConfiguration
All Implemented Interfaces:
IInspectable, IMatchmakingConfigurationRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.368Z") @Stability(Stable) public class CfnMatchmakingConfiguration extends CfnResource implements IInspectable, IMatchmakingConfigurationRef, ITaggable
The AWS::GameLift::MatchmakingConfiguration resource defines a new matchmaking configuration for use with FlexMatch.

Whether you're using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes that are consistent with that configuration.

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.*;
 CfnMatchmakingConfiguration cfnMatchmakingConfiguration = CfnMatchmakingConfiguration.Builder.create(this, "MyCfnMatchmakingConfiguration")
         .acceptanceRequired(false)
         .name("name")
         .requestTimeoutSeconds(123)
         .ruleSetName("ruleSetName")
         // the properties below are optional
         .acceptanceTimeoutSeconds(123)
         .additionalPlayerCount(123)
         .backfillMode("backfillMode")
         .creationTime("creationTime")
         .customEventData("customEventData")
         .description("description")
         .flexMatchMode("flexMatchMode")
         .gameProperties(List.of(GamePropertyProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .gameSessionData("gameSessionData")
         .gameSessionQueueArns(List.of("gameSessionQueueArns"))
         .notificationTarget("notificationTarget")
         .ruleSetArn("ruleSetArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMatchmakingConfiguration

      protected CfnMatchmakingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMatchmakingConfiguration

      protected CfnMatchmakingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMatchmakingConfiguration

      @Stability(Stable) public CfnMatchmakingConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMatchmakingConfigurationProps props)
      Create a new AWS::GameLift::MatchmakingConfiguration.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForMatchmakingConfiguration

      @Stability(Stable) @NotNull public static String arnForMatchmakingConfiguration(@NotNull IMatchmakingConfigurationRef resource)
      Parameters:
      resource - This parameter is required.

    • fromMatchmakingConfigurationArn

      @Stability(Stable) @NotNull public static IMatchmakingConfigurationRef fromMatchmakingConfigurationArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IMatchmakingConfigurationRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromMatchmakingConfigurationName

      @Stability(Stable) @NotNull public static IMatchmakingConfigurationRef fromMatchmakingConfigurationName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String matchmakingConfigurationName)
      Creates a new IMatchmakingConfigurationRef from a matchmakingConfigurationName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      matchmakingConfigurationName - This parameter is required.

    • isCfnMatchmakingConfiguration

      @Stability(Stable) @NotNull public static Boolean isCfnMatchmakingConfiguration(@NotNull Object x)
      Checks whether the given object is a CfnMatchmakingConfiguration.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The unique Amazon Resource Name (ARN) for the MatchmakingConfiguration .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The MatchmakingConfiguration name, which is unique.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMatchmakingConfigurationRef

      @Stability(Stable) @NotNull public MatchmakingConfigurationReference getMatchmakingConfigurationRef()
      A reference to a MatchmakingConfiguration resource.
      Specified by:
      getMatchmakingConfigurationRef in interface IMatchmakingConfigurationRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAcceptanceRequired

      @Stability(Stable) @NotNull public Object getAcceptanceRequired()
      A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

      Returns union: either Boolean or IResolvable

    • setAcceptanceRequired

      @Stability(Stable) public void setAcceptanceRequired(@NotNull Boolean value)
      A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

    • setAcceptanceRequired

      @Stability(Stable) public void setAcceptanceRequired(@NotNull IResolvable value)
      A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

    • getName

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

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A unique identifier for the matchmaking configuration.

    • getRequestTimeoutSeconds

      @Stability(Stable) @NotNull public Number getRequestTimeoutSeconds()
      The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.

    • setRequestTimeoutSeconds

      @Stability(Stable) public void setRequestTimeoutSeconds(@NotNull Number value)
      The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.

    • getRuleSetName

      @Stability(Stable) @NotNull public String getRuleSetName()
      A unique identifier for the matchmaking rule set to use with this configuration.

    • setRuleSetName

      @Stability(Stable) public void setRuleSetName(@NotNull String value)
      A unique identifier for the matchmaking rule set to use with this configuration.

    • getAcceptanceTimeoutSeconds

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

    • setAcceptanceTimeoutSeconds

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

    • getAdditionalPlayerCount

      @Stability(Stable) @Nullable public Number getAdditionalPlayerCount()
      The number of player slots in a match to keep open for future players.

    • setAdditionalPlayerCount

      @Stability(Stable) public void setAdditionalPlayerCount(@Nullable Number value)
      The number of player slots in a match to keep open for future players.

    • getBackfillMode

      @Stability(Stable) @Nullable public String getBackfillMode()
      The method used to backfill game sessions that are created with this matchmaking configuration.

    • setBackfillMode

      @Stability(Stable) public void setBackfillMode(@Nullable String value)
      The method used to backfill game sessions that are created with this matchmaking configuration.

    • getCreationTime

      @Stability(Stable) @Nullable public String getCreationTime()
      A time stamp indicating when this data object was created.

    • setCreationTime

      @Stability(Stable) public void setCreationTime(@Nullable String value)
      A time stamp indicating when this data object was created.

    • getCustomEventData

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

    • setCustomEventData

      @Stability(Stable) public void setCustomEventData(@Nullable String value)
      Information to add to all events related to the matchmaking configuration.

    • getDescription

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

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the matchmaking configuration.

    • getFlexMatchMode

      @Stability(Stable) @Nullable public String getFlexMatchMode()
      Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.

    • setFlexMatchMode

      @Stability(Stable) public void setFlexMatchMode(@Nullable String value)
      Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.

    • getGameProperties

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

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMatchmakingConfiguration.GamePropertyProperty>

    • setGameProperties

      @Stability(Stable) public void setGameProperties(@Nullable IResolvable value)
      A set of custom properties for a game session, formatted as key-value pairs.

    • setGameProperties

      @Stability(Stable) public void setGameProperties(@Nullable List<Object> value)
      A set of custom properties for a game session, formatted as key-value pairs.

    • getGameSessionData

      @Stability(Stable) @Nullable public String getGameSessionData()
      A set of custom game session properties, formatted as a single string value.

    • setGameSessionData

      @Stability(Stable) public void setGameSessionData(@Nullable String value)
      A set of custom game session properties, formatted as a single string value.

    • getGameSessionQueueArns

      @Stability(Stable) @Nullable public List<String> getGameSessionQueueArns()
      The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers 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 Servers-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE , do not set this parameter.

    • setGameSessionQueueArns

      @Stability(Stable) public void setGameSessionQueueArns(@Nullable List<String> value)
      The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers 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 Servers-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 public String getNotificationTarget()
      An SNS topic ARN that is set up to receive matchmaking notifications.

    • setNotificationTarget

      @Stability(Stable) public void setNotificationTarget(@Nullable String value)
      An SNS topic ARN that is set up to receive matchmaking notifications.

    • getRuleSetArn

      @Stability(Stable) @Nullable public String getRuleSetArn()
      The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.

    • setRuleSetArn

      @Stability(Stable) public void setRuleSetArn(@Nullable String value)
      The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.

    • getTagsRaw

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

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of labels to assign to the new matchmaking configuration resource.