Package software.amazon.awscdk.services.gamelift

Class CfnMatchmakingRuleSet

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.CfnMatchmakingRuleSet
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IMatchmakingRuleSetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:06.737Z") @Stability(Stable) public class CfnMatchmakingRuleSet extends CfnResource implements IInspectable, IMatchmakingRuleSetRef, ITaggable
Creates a new rule set for FlexMatch matchmaking.

A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax.

Learn more

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.*;
 CfnMatchmakingRuleSet cfnMatchmakingRuleSet = CfnMatchmakingRuleSet.Builder.create(this, "MyCfnMatchmakingRuleSet")
         .name("name")
         .ruleSetBody("ruleSetBody")
         // the properties below are optional
         .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

    • CfnMatchmakingRuleSet

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

    • CfnMatchmakingRuleSet

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

    • CfnMatchmakingRuleSet

      @Stability(Stable) public CfnMatchmakingRuleSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMatchmakingRuleSetProps props)
      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

    • fromMatchmakingRuleSetArn

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

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

    • fromMatchmakingRuleSetName

      @Stability(Stable) @NotNull public static IMatchmakingRuleSetRef fromMatchmakingRuleSetName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String matchmakingRuleSetName)
      Creates a new IMatchmakingRuleSetRef from a matchmakingRuleSetName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      matchmakingRuleSetName - 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) assigned to the rule set.

    • getAttrCreationTime

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

      Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The unique name of the rule set.

    • getCfnProperties

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

    • getMatchmakingRuleSetRef

      @Stability(Stable) @NotNull public MatchmakingRuleSetReference getMatchmakingRuleSetRef()
      A reference to a MatchmakingRuleSet resource.
      Specified by:
      getMatchmakingRuleSetRef in interface IMatchmakingRuleSetRef

    • getTags

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

    • getName

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

    • setName

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

    • getRuleSetBody

      @Stability(Stable) @NotNull public String getRuleSetBody()
      A collection of matchmaking rules, formatted as a JSON string.

    • setRuleSetBody

      @Stability(Stable) public void setRuleSetBody(@NotNull String value)
      A collection of matchmaking rules, formatted as a JSON string.

    • getTagsRaw

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

    • setTagsRaw

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