Class CfnMatchmakingConfiguration
The AWS::GameLift::MatchmakingConfiguration
resource defines a new matchmaking configuration for use with FlexMatch.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMatchmakingConfiguration : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnMatchmakingConfiguration
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
Whether you're using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes that are consistent with that configuration.
CloudformationResource: AWS::GameLift::MatchmakingConfiguration
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 cfnMatchmakingConfiguration = new CfnMatchmakingConfiguration(this, "MyCfnMatchmakingConfiguration", new CfnMatchmakingConfigurationProps {
AcceptanceRequired = false,
Name = "name",
RequestTimeoutSeconds = 123,
RuleSetName = "ruleSetName",
// the properties below are optional
AcceptanceTimeoutSeconds = 123,
AdditionalPlayerCount = 123,
BackfillMode = "backfillMode",
CreationTime = "creationTime",
CustomEventData = "customEventData",
Description = "description",
FlexMatchMode = "flexMatchMode",
GameProperties = new [] { new GamePropertyProperty {
Key = "key",
Value = "value"
} },
GameSessionData = "gameSessionData",
GameSessionQueueArns = new [] { "gameSessionQueueArns" },
NotificationTarget = "notificationTarget",
RuleSetArn = "ruleSetArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnMatchmakingConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMatchmakingConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnMatchmakingConfiguration(Construct, String, ICfnMatchmakingConfigurationProps) |
Properties
AcceptanceRequired | A flag that determines whether a match that was created with this configuration must be accepted by the matched players. |
AcceptanceTimeoutSeconds | The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. |
AdditionalPlayerCount | The number of player slots in a match to keep open for future players. |
AttrArn | The unique Amazon Resource Name (ARN) for the |
AttrName | The |
BackfillMode | The method used to backfill game sessions that are created with this matchmaking configuration. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CreationTime | A time stamp indicating when this data object was created. |
CustomEventData | Information to add to all events related to the matchmaking configuration. |
Description | A description for the matchmaking configuration. |
FlexMatchMode | Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. |
GameProperties | A set of custom properties for a game session, formatted as key-value pairs. |
GameSessionData | A set of custom game session properties, formatted as a single string value. |
GameSessionQueueArns | The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is |
Name | A unique identifier for the matchmaking configuration. |
NotificationTarget | An SNS topic ARN that is set up to receive matchmaking notifications. |
RequestTimeoutSeconds | The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. |
RuleSetArn | The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses. |
RuleSetName | A unique identifier for the matchmaking rule set to use with this configuration. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of labels to assign to the new matchmaking configuration resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMatchmakingConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMatchmakingConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMatchmakingConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMatchmakingConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnMatchmakingConfiguration(Construct, String, ICfnMatchmakingConfigurationProps)
public CfnMatchmakingConfiguration(Construct scope, string id, ICfnMatchmakingConfigurationProps 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 ICfnMatchmakingConfigurationProps
Resource properties.
Properties
AcceptanceRequired
A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
public virtual object AcceptanceRequired { get; set; }
Property Value
System.Object
AcceptanceTimeoutSeconds
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
public virtual Nullable<double> AcceptanceTimeoutSeconds { get; set; }
Property Value
System.Nullable<System.Double>
AdditionalPlayerCount
The number of player slots in a match to keep open for future players.
public virtual Nullable<double> AdditionalPlayerCount { get; set; }
Property Value
System.Nullable<System.Double>
AttrArn
The unique Amazon Resource Name (ARN) for the MatchmakingConfiguration
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrName
The MatchmakingConfiguration
name, which is unique.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
BackfillMode
The method used to backfill game sessions that are created with this matchmaking configuration.
public virtual string BackfillMode { get; set; }
Property Value
System.String
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
CreationTime
A time stamp indicating when this data object was created.
public virtual string CreationTime { get; set; }
Property Value
System.String
CustomEventData
Information to add to all events related to the matchmaking configuration.
public virtual string CustomEventData { get; set; }
Property Value
System.String
Description
A description for the matchmaking configuration.
public virtual string Description { get; set; }
Property Value
System.String
FlexMatchMode
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
public virtual string FlexMatchMode { get; set; }
Property Value
System.String
GameProperties
A set of custom properties for a game session, formatted as key-value pairs.
public virtual object GameProperties { get; set; }
Property Value
System.Object
GameSessionData
A set of custom game session properties, formatted as a single string value.
public virtual string GameSessionData { get; set; }
Property Value
System.String
GameSessionQueueArns
The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>
. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode
is set to STANDALONE
, do not set this parameter.
public virtual string[] GameSessionQueueArns { get; set; }
Property Value
System.String[]
Name
A unique identifier for the matchmaking configuration.
public virtual string Name { get; set; }
Property Value
System.String
NotificationTarget
An SNS topic ARN that is set up to receive matchmaking notifications.
public virtual string NotificationTarget { get; set; }
Property Value
System.String
RequestTimeoutSeconds
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
public virtual double RequestTimeoutSeconds { get; set; }
Property Value
System.Double
RuleSetArn
The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.
public virtual string RuleSetArn { get; set; }
Property Value
System.String
RuleSetName
A unique identifier for the matchmaking rule set to use with this configuration.
public virtual string RuleSetName { 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 configuration 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>