Class CfnMatchmakingRuleSet

A CloudFormation AWS::GameLift::MatchmakingRuleSet.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnMatchmakingRuleSet
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.AWS.GameLift.dll
Syntax (csharp)
public class CfnMatchmakingRuleSet : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnMatchmakingRuleSet
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

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

    CloudformationResource: AWS::GameLift::MatchmakingRuleSet

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html

    ExampleMetadata: fixture=_generated

    Examples
    // The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;

CfnMatchmakingRuleSet cfnMatchmakingRuleSet = new CfnMatchmakingRuleSet(this, "MyCfnMatchmakingRuleSet", new CfnMatchmakingRuleSetProps {
    Name = "name",
    RuleSetBody = "ruleSetBody",

    // the properties below are optional
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

    Synopsis

    Constructors

    CfnMatchmakingRuleSet(Construct, String, ICfnMatchmakingRuleSetProps)

    Create a new AWS::GameLift::MatchmakingRuleSet.
    CfnMatchmakingRuleSet(ByRefValue)

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

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

    Properties

    AttrArn

    The unique Amazon Resource Name (ARN) assigned to the rule set.
    AttrName

    The unique name of the rule set.
    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.
    CfnProperties
    Name

    A unique identifier for the matchmaking rule set.
    RuleSetBody

    A collection of matchmaking rules, formatted as a JSON string.
    Tags

    A list of labels to assign to the new matchmaking rule set resource.

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.
    RenderProperties(IDictionary<String, Object>)

    Constructors

    CfnMatchmakingRuleSet(Construct, String, ICfnMatchmakingRuleSetProps)

    Create a new AWS::GameLift::MatchmakingRuleSet.

    public CfnMatchmakingRuleSet(Construct scope, string id, ICfnMatchmakingRuleSetProps props)
    Parameters
    scope Construct
    • scope in which this resource is defined.
    id System.String
    • scoped id of the resource.
    props ICfnMatchmakingRuleSetProps
    • resource properties.

    CfnMatchmakingRuleSet(ByRefValue)

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

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

    The Javascript-owned object reference

    CfnMatchmakingRuleSet(DeputyBase.DeputyProps)

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

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

    The deputy props

    Properties

    AttrArn

    The unique Amazon Resource Name (ARN) assigned to the rule set.

    public virtual string AttrArn { get; }
    Property Value

    System.String

    Remarks

    CloudformationAttribute: Arn

    AttrName

    The unique name of the rule set.

    public virtual string AttrName { get; }
    Property Value

    System.String

    Remarks

    CloudformationAttribute: Name

    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.

    public static string CFN_RESOURCE_TYPE_NAME { get; }
    Property Value

    System.String

    CfnProperties

    protected override IDictionary<string, object> CfnProperties { get; }
    Property Value

    System.Collections.Generic.IDictionary<System.String, System.Object>

    Overrides

    Name

    A unique identifier for the matchmaking rule set.

    public virtual string Name { get; set; }
    Property Value

    System.String

    Remarks

    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.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-name

    RuleSetBody

    A collection of matchmaking rules, formatted as a JSON string.

    public virtual string RuleSetBody { get; set; }
    Property Value

    System.String

    Remarks

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

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-rulesetbody

    Tags

    A list of labels to assign to the new matchmaking rule set resource.

    public virtual TagManager Tags { get; }
    Property Value

    TagManager

    Remarks

    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.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-tags

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.

    public virtual void Inspect(TreeInspector inspector)
    Parameters
    inspector TreeInspector
    • tree inspector to collect and process attributes.

    RenderProperties(IDictionary<String, Object>)

    protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
    Parameters
    props System.Collections.Generic.IDictionary<System.String, System.Object>
    Returns

    System.Collections.Generic.IDictionary<System.String, System.Object>

    Overrides

    Implements

    Constructs.IConstruct