Interface CfnMatchmakingConfigurationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnMatchmakingConfigurationProps.Jsii$Proxy
CfnMatchmakingConfiguration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.gamelift.*;
CfnMatchmakingConfigurationProps cfnMatchmakingConfigurationProps = CfnMatchmakingConfigurationProps.builder()
.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(List.of(GamePropertyProperty.builder()
.key("key")
.value("value")
.build()))
.gameSessionData("gameSessionData")
.gameSessionQueueArns(List.of("gameSessionQueueArns"))
.notificationTarget("notificationTarget")
.ruleSetArn("ruleSetArn")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnMatchmakingConfigurationPropsstatic final classAn implementation forCfnMatchmakingConfigurationProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()A flag that determines whether a match that was created with this configuration must be accepted by the matched players.default NumberThe length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.default NumberThe number of player slots in a match to keep open for future players.default StringThe method used to backfill game sessions that are created with this matchmaking configuration.default StringA time stamp indicating when this data object was created.default StringInformation to add to all events related to the matchmaking configuration.default StringA description for the matchmaking configuration.default StringIndicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.default ObjectA set of custom properties for a game session, formatted as key-value pairs.default StringA set of custom game session properties, formatted as a single string value.The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.getName()A unique identifier for the matchmaking configuration.default StringAn SNS topic ARN that is set up to receive matchmaking notifications.The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.default StringThe Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.A unique identifier for the matchmaking rule set to use with this configuration.getTags()A list of labels to assign to the new matchmaking configuration resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAcceptanceRequired
A flag that determines whether a match that was created with this configuration must be accepted by the matched players.To require acceptance, set to
TRUE. With this option enabled, matchmaking tickets use the statusREQUIRES_ACCEPTANCEto indicate when a completed potential match is waiting for player acceptance.- See Also:
-
getName
A unique identifier for the matchmaking configuration.This name is used to identify the configuration associated with a matchmaking request or ticket.
- See Also:
-
getRequestTimeoutSeconds
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.Requests that fail due to timing out can be resubmitted as needed.
- See Also:
-
getRuleSetName
A unique identifier for the matchmaking rule set to use with this configuration.You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.
- See Also:
-
getAcceptanceTimeoutSeconds
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.- See Also:
-
getAdditionalPlayerCount
The number of player slots in a match to keep open for future players.For example, if the configuration's rule set specifies a match for a single 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used if
FlexMatchModeis set toSTANDALONE.- See Also:
-
getBackfillMode
The method used to backfill game sessions that are created with this matchmaking configuration.Specify
MANUALwhen your game manages backfill requests manually or does not use the match backfill feature. SpecifyAUTOMATICto have GameLift create aStartMatchBackfillrequest 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 whenFlexMatchModeis set toSTANDALONE.- See Also:
-
getCreationTime
A time stamp indicating when this data object was created.Format is a number expressed in Unix time as milliseconds (for example
"1469498468.057").- See Also:
-
getCustomEventData
Information to add to all events related to the matchmaking configuration.- See Also:
-
getDescription
A description for the matchmaking configuration.- See Also:
-
getFlexMatchMode
Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.- STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
- WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.
- See Also:
-
getGameProperties
A set of custom properties for a game session, formatted as key-value pairs.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
FlexMatchModeis set toSTANDALONE.- See Also:
-
getGameSessionData
A set of custom game session properties, formatted as a single string value.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
FlexMatchModeis set toSTANDALONE.- See Also:
-
getGameSessionQueueArns
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 isarn: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. IfFlexMatchModeis set toSTANDALONE, do not set this parameter.- See Also:
-
getNotificationTarget
An SNS topic ARN that is set up to receive matchmaking notifications.See Setting up notifications for matchmaking for more information.
- See Also:
-
getRuleSetArn
The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.- See Also:
-
getTags
A list of labels to assign to the new matchmaking configuration resource.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.
- See Also:
-
builder
-