@Stability(value=Stable) public static final class CfnMatchmakingConfigurationProps.Builder extends Object implements software.amazon.jsii.Builder<CfnMatchmakingConfigurationProps>
CfnMatchmakingConfigurationProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder acceptanceRequired(Boolean acceptanceRequired)
CfnMatchmakingConfigurationProps.getAcceptanceRequired()acceptanceRequired - A flag that determines whether a match that was created with this configuration must be accepted by the matched players. This parameter is required.
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.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder acceptanceRequired(IResolvable acceptanceRequired)
CfnMatchmakingConfigurationProps.getAcceptanceRequired()acceptanceRequired - A flag that determines whether a match that was created with this configuration must be accepted by the matched players. This parameter is required.
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.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder name(String name)
CfnMatchmakingConfigurationProps.getName()name - A unique identifier for the matchmaking configuration. This parameter is required.
This name is used to identify the configuration associated with a matchmaking request or ticket.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder requestTimeoutSeconds(Number requestTimeoutSeconds)
CfnMatchmakingConfigurationProps.getRequestTimeoutSeconds()requestTimeoutSeconds - The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. This parameter is required.
Requests that fail due to timing out can be resubmitted as needed.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder ruleSetName(String ruleSetName)
CfnMatchmakingConfigurationProps.getRuleSetName()ruleSetName - A unique identifier for the matchmaking rule set to use with this configuration. This parameter is required.
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.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder acceptanceTimeoutSeconds(Number acceptanceTimeoutSeconds)
CfnMatchmakingConfigurationProps.getAcceptanceTimeoutSeconds()acceptanceTimeoutSeconds - The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder additionalPlayerCount(Number additionalPlayerCount)
CfnMatchmakingConfigurationProps.getAdditionalPlayerCount()additionalPlayerCount - 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 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 .this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder backfillMode(String backfillMode)
CfnMatchmakingConfigurationProps.getBackfillMode()backfillMode - The method used to backfill game sessions that are created with this matchmaking configuration.
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 .this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder customEventData(String customEventData)
CfnMatchmakingConfigurationProps.getCustomEventData()customEventData - Information to add to all events related to the matchmaking configuration.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder description(String description)
CfnMatchmakingConfigurationProps.getDescription()description - A descriptive label that is associated with matchmaking configuration.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder flexMatchMode(String flexMatchMode)
CfnMatchmakingConfigurationProps.getFlexMatchMode()flexMatchMode - Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder gameProperties(IResolvable gameProperties)
CfnMatchmakingConfigurationProps.getGameProperties()gameProperties - 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 FlexMatchMode is set to STANDALONE .this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder gameProperties(List<? extends Object> gameProperties)
CfnMatchmakingConfigurationProps.getGameProperties()gameProperties - 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 FlexMatchMode is set to STANDALONE .this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder gameSessionData(String gameSessionData)
CfnMatchmakingConfigurationProps.getGameSessionData()gameSessionData - 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 FlexMatchMode is set to STANDALONE .this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder gameSessionQueueArns(List<String> gameSessionQueueArns)
CfnMatchmakingConfigurationProps.getGameSessionQueueArns()gameSessionQueueArns - The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder notificationTarget(String notificationTarget)
CfnMatchmakingConfigurationProps.getNotificationTarget()notificationTarget - An SNS topic ARN that is set up to receive matchmaking notifications.
See Setting up notifications for matchmaking for more information.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps.Builder tags(List<? extends CfnTag> tags)
CfnMatchmakingConfigurationProps.getTags()tags - 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.this@Stability(value=Stable) public CfnMatchmakingConfigurationProps build()
build in interface software.amazon.jsii.Builder<CfnMatchmakingConfigurationProps>CfnMatchmakingConfigurationPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.