Class CfnMatchmakingRuleSet
Creates a new rule set for FlexMatch matchmaking.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMatchmakingRuleSet : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnMatchmakingRuleSet
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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
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;
var 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(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 |
CfnMatchmakingRuleSet(Construct, String, ICfnMatchmakingRuleSetProps) |
Properties
AttrArn | The unique Amazon Resource Name (ARN) assigned to the rule set. |
AttrCreationTime | A time stamp indicating when this data object was created. |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnMatchmakingRuleSet(Construct, String, ICfnMatchmakingRuleSetProps)
public CfnMatchmakingRuleSet(Construct scope, string id, ICfnMatchmakingRuleSetProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnMatchmakingRuleSetProps
Resource properties.
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
AttrCreationTime
A time stamp indicating when this data object was created.
public virtual string AttrCreationTime { get; }
Property Value
System.String
Remarks
Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
CloudformationAttribute: CreationTime
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
RuleSetBody
A collection of matchmaking rules, formatted as a JSON string.
public virtual string RuleSetBody { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of labels to assign to the new matchmaking rule set resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>