Interface ICfnMatchmakingConfigurationProps

Properties for defining a CfnMatchmakingConfiguration.

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnMatchmakingConfigurationProps

Syntax (vb)

Public Interface ICfnMatchmakingConfigurationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.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;

             var cfnMatchmakingConfigurationProps = 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

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.
BackfillMode	The method used to backfill game sessions that are created with this matchmaking configuration.
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 Servers 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 Servers 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 Servers-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter.
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	A list of labels to assign to the new matchmaking configuration resource.

Properties

AcceptanceRequired

A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

object AcceptanceRequired { get; }

Property Value

object

Remarks

To require acceptance, set to TRUE . With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancerequired

Type union: either bool or IResolvable

AcceptanceTimeoutSeconds

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

double? AcceptanceTimeoutSeconds { get; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-acceptancetimeoutseconds

AdditionalPlayerCount

The number of player slots in a match to keep open for future players.

double? AdditionalPlayerCount { get; }

Property Value

double?

Remarks

For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to STANDALONE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-additionalplayercount

BackfillMode

The method used to backfill game sessions that are created with this matchmaking configuration.

string? BackfillMode { get; }

Property Value

string

Remarks

Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch . Automatic backfill is not available when FlexMatchMode is set to STANDALONE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-backfillmode

CreationTime

A time stamp indicating when this data object was created.

string? CreationTime { get; }

Property Value

string

Remarks

Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-creationtime

CustomEventData

Information to add to all events related to the matchmaking configuration.

string? CustomEventData { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-customeventdata

Description

A description for the matchmaking configuration.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-description

FlexMatchMode

Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.

string? FlexMatchMode { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-flexmatchmode

GameProperties

A set of custom properties for a game session, formatted as key-value pairs.

object? GameProperties { get; }

Property Value

object

Remarks

These properties are passed to a game server process with a request to start a new game session. See Start a Game Session . This parameter is not used if FlexMatchMode is set to STANDALONE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gameproperties

Type union: either IResolvable or (either IResolvable or CfnMatchmakingConfiguration.IGamePropertyProperty)[]

GameSessionData

A set of custom game session properties, formatted as a single string value.

string? GameSessionData { get; }

Property Value

string

Remarks

This data is passed to a game server process with a request to start a new game session. See Start a Game Session . This parameter is not used if FlexMatchMode is set to STANDALONE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingconfiguration.html#cfn-gamelift-matchmakingconfiguration-gamesessiondata

GameSessionQueueArns

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers 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 Servers-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE , do not set this parameter.