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, IMatchmakingRuleSetRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnMatchmakingRuleSet Inherits CfnResource Implements IInspectable, IMatchmakingRuleSetRef, IConstruct, IDependable, IEnvironmentAware, 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(Construct, string, ICfnMatchmakingRuleSetProps) | Creates a new rule set for FlexMatch matchmaking. |
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 | Creates a new rule set for FlexMatch matchmaking. |
| MatchmakingRuleSetRef | A reference to a MatchmakingRuleSet resource. |
| 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
| FromMatchmakingRuleSetArn(Construct, string, string) | Creates a new IMatchmakingRuleSetRef from an ARN. |
| FromMatchmakingRuleSetName(Construct, string, string) | Creates a new IMatchmakingRuleSetRef from a matchmakingRuleSetName. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<string, object>) | Creates a new rule set for FlexMatch matchmaking. |
Constructors
CfnMatchmakingRuleSet(Construct, string, ICfnMatchmakingRuleSetProps)
Creates a new rule set for FlexMatch matchmaking.
public CfnMatchmakingRuleSet(Construct scope, string id, ICfnMatchmakingRuleSetProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnMatchmakingRuleSetProps
Resource properties.
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
Properties
AttrArn
The unique Amazon Resource Name (ARN) assigned to the rule set.
public virtual string AttrArn { get; }
Property Value
Remarks
CloudformationAttribute: Arn
AttrCreationTime
A time stamp indicating when this data object was created.
public virtual string AttrCreationTime { get; }
Property Value
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
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
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
CfnProperties
Creates a new rule set for FlexMatch matchmaking.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
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
MatchmakingRuleSetRef
A reference to a MatchmakingRuleSet resource.
public virtual IMatchmakingRuleSetReference MatchmakingRuleSetRef { get; }
Property Value
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
Name
A unique identifier for the matchmaking rule set.
public virtual string Name { get; set; }
Property Value
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
RuleSetBody
A collection of matchmaking rules, formatted as a JSON string.
public virtual string RuleSetBody { get; set; }
Property Value
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
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
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
TagsRaw
A list of labels to assign to the new matchmaking rule set resource.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
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
Methods
FromMatchmakingRuleSetArn(Construct, string, string)
Creates a new IMatchmakingRuleSetRef from an ARN.
public static IMatchmakingRuleSetRef FromMatchmakingRuleSetArn(Construct scope, string id, string arn)
Parameters
Returns
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
FromMatchmakingRuleSetName(Construct, string, string)
Creates a new IMatchmakingRuleSetRef from a matchmakingRuleSetName.
public static IMatchmakingRuleSetRef FromMatchmakingRuleSetName(Construct scope, string id, string matchmakingRuleSetName)
Parameters
Returns
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
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.
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
RenderProperties(IDictionary<string, object>)
Creates a new rule set for FlexMatch matchmaking.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
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