Class MatchmakingRuleSet

(experimental) Creates a new rule set for FlexMatch matchmaking.

Inheritance
System.Object
Resource
MatchmakingRuleSetBase
MatchmakingRuleSet
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift.Alpha
Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll
Syntax (csharp)
public class MatchmakingRuleSet : MatchmakingRuleSetBase, IMatchmakingRuleSet, IResource
Syntax (vb)
Public Class MatchmakingRuleSet
    Inherits MatchmakingRuleSetBase
    Implements IMatchmakingRuleSet, IResource
Remarks

The rule set determines the two key elements of a match: your game's team structure and size, and how to group players together for the best possible match.

For example, a rule set might describe a match like this:

    Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

    Stability: Experimental

    See: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html

    Resource: AWS::GameLift::MatchmakingRuleSet

    ExampleMetadata: infused

    Examples
    new MatchmakingRuleSet(this, "RuleSet", new MatchmakingRuleSetProps {
    MatchmakingRuleSetName = "my-test-ruleset",
    Content = RuleSetContent.FromJsonFile(Join(__dirname, "my-ruleset", "ruleset.json"))
});

    Synopsis

    Constructors

    MatchmakingRuleSet(ByRefValue)

    Used by jsii to construct an instance of this class from a Javascript-owned object reference
    MatchmakingRuleSet(DeputyBase.DeputyProps)

    Used by jsii to construct an instance of this class from DeputyProps
    MatchmakingRuleSet(Construct, String, IMatchmakingRuleSetProps)

    Properties

    MatchmakingRuleSetArn

    (experimental) The ARN of the ruleSet.
    MatchmakingRuleSetName

    (experimental) The unique name of the ruleSet.

    Methods

    FromMatchmakingRuleSetArn(Construct, String, String)

    (experimental) Import a ruleSet into CDK using its ARN.
    FromMatchmakingRuleSetAttributes(Construct, String, IMatchmakingRuleSetAttributes)

    (experimental) Import an existing matchmaking ruleSet from its attributes.
    FromMatchmakingRuleSetName(Construct, String, String)

    (experimental) Import a ruleSet into CDK using its name.

    Constructors

    MatchmakingRuleSet(ByRefValue)

    Used by jsii to construct an instance of this class from a Javascript-owned object reference

    protected MatchmakingRuleSet(ByRefValue reference)
    Parameters
    reference Amazon.JSII.Runtime.Deputy.ByRefValue

    The Javascript-owned object reference

    MatchmakingRuleSet(DeputyBase.DeputyProps)

    Used by jsii to construct an instance of this class from DeputyProps

    protected MatchmakingRuleSet(DeputyBase.DeputyProps props)
    Parameters
    props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

    The deputy props

    MatchmakingRuleSet(Construct, String, IMatchmakingRuleSetProps)

    public MatchmakingRuleSet(Construct scope, string id, IMatchmakingRuleSetProps props)
    Parameters
    scope Constructs.Construct
    id System.String
    props IMatchmakingRuleSetProps
    Remarks

    Stability: Experimental

    Properties

    MatchmakingRuleSetArn

    (experimental) The ARN of the ruleSet.

    public override string MatchmakingRuleSetArn { get; }
    Property Value

    System.String

    Overrides
    Remarks

    Stability: Experimental

    MatchmakingRuleSetName

    (experimental) The unique name of the ruleSet.

    public override string MatchmakingRuleSetName { get; }
    Property Value

    System.String

    Overrides
    Remarks

    Stability: Experimental

    Methods

    FromMatchmakingRuleSetArn(Construct, String, String)

    (experimental) Import a ruleSet into CDK using its ARN.

    public static IMatchmakingRuleSet FromMatchmakingRuleSetArn(Construct scope, string id, string matchmakingRuleSetArn)
    Parameters
    scope Constructs.Construct
    id System.String
    matchmakingRuleSetArn System.String
    Returns

    IMatchmakingRuleSet

    Remarks

    Stability: Experimental

    FromMatchmakingRuleSetAttributes(Construct, String, IMatchmakingRuleSetAttributes)

    (experimental) Import an existing matchmaking ruleSet from its attributes.

    public static IMatchmakingRuleSet FromMatchmakingRuleSetAttributes(Construct scope, string id, IMatchmakingRuleSetAttributes attrs)
    Parameters
    scope Constructs.Construct
    id System.String
    attrs IMatchmakingRuleSetAttributes
    Returns

    IMatchmakingRuleSet

    Remarks

    Stability: Experimental

    FromMatchmakingRuleSetName(Construct, String, String)

    (experimental) Import a ruleSet into CDK using its name.

    public static IMatchmakingRuleSet FromMatchmakingRuleSetName(Construct scope, string id, string matchmakingRuleSetName)
    Parameters
    scope Constructs.Construct
    id System.String
    matchmakingRuleSetName System.String
    Returns

    IMatchmakingRuleSet

    Remarks

    Stability: Experimental

    Implements

    Constructs.IConstruct
    Constructs.IDependable