Package software.amazon.awscdk.services.gamelift

Class CfnMatchmakingRuleSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.gamelift.CfnMatchmakingRuleSet
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.910Z") @Stability(Stable) public class CfnMatchmakingRuleSet extends CfnResource implements IInspectable
A CloudFormation AWS::GameLift::MatchmakingRuleSet.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnMatchmakingRuleSetProps props)
      Create a new AWS::GameLift::MatchmakingRuleSet.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of labels to assign to the new matchmaking rule set 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.

    • getName

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

      A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

    • setName

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

      A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

    • getRuleSetBody

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

      Comments are not allowed in JSON, but most elements support a description field.

    • setRuleSetBody

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

      Comments are not allowed in JSON, but most elements support a description field.