Package software.amazon.awscdk.services.gamelift.alpha

Class MatchmakingConfigurationProps.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.alpha.MatchmakingConfigurationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MatchmakingConfigurationProps>

Enclosing interface:

MatchmakingConfigurationProps

@Stability(Experimental)
public static final class MatchmakingConfigurationProps.Builder
extends Object
implements software.amazon.jsii.Builder<MatchmakingConfigurationProps>

A builder for MatchmakingConfigurationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MatchmakingConfigurationProps.Builder	acceptanceTimeout(Duration acceptanceTimeout)	Sets the value of MatchmakingConfigurationProps.getAcceptanceTimeout()
MatchmakingConfigurationProps	build()	Builds the configured instance.
MatchmakingConfigurationProps.Builder	customEventData(String customEventData)	Sets the value of MatchmakingConfigurationProps.getCustomEventData()
MatchmakingConfigurationProps.Builder	description(String description)	Sets the value of MatchmakingConfigurationProps.getDescription()
MatchmakingConfigurationProps.Builder	matchmakingConfigurationName(String matchmakingConfigurationName)	Sets the value of MatchmakingConfigurationProps.getMatchmakingConfigurationName()
MatchmakingConfigurationProps.Builder	notificationTarget(ITopic notificationTarget)	Sets the value of MatchmakingConfigurationProps.getNotificationTarget()
MatchmakingConfigurationProps.Builder	requestTimeout(Duration requestTimeout)	Sets the value of MatchmakingConfigurationProps.getRequestTimeout()
MatchmakingConfigurationProps.Builder	requireAcceptance(Boolean requireAcceptance)	Sets the value of MatchmakingConfigurationProps.getRequireAcceptance()
MatchmakingConfigurationProps.Builder	ruleSet(IMatchmakingRuleSet ruleSet)	Sets the value of MatchmakingConfigurationProps.getRuleSet()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

matchmakingConfigurationName

@Stability(Experimental)
public MatchmakingConfigurationProps.Builder matchmakingConfigurationName(String matchmakingConfigurationName)

Sets the value of MatchmakingConfigurationProps.getMatchmakingConfigurationName()

Parameters:

matchmakingConfigurationName - 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.

Returns:

this

ruleSet

@Stability(Experimental)
public MatchmakingConfigurationProps.Builder ruleSet(IMatchmakingRuleSet ruleSet)

Sets the value of MatchmakingConfigurationProps.getRuleSet()

Parameters:

ruleSet - A matchmaking rule set to use with this configuration. This parameter is required. A matchmaking configuration can only use rule sets that are defined in the same Region.

Returns:

this

acceptanceTimeout

@Stability(Experimental)
public MatchmakingConfigurationProps.Builder acceptanceTimeout(Duration acceptanceTimeout)

Sets the value of MatchmakingConfigurationProps.getAcceptanceTimeout()

Parameters:

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

Returns:

this

customEventData

@Stability(Experimental)
public MatchmakingConfigurationProps.Builder customEventData(String customEventData)

Sets the value of MatchmakingConfigurationProps.getCustomEventData()

Parameters:

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

Returns:

this

description

@Stability(Experimental)
public MatchmakingConfigurationProps.Builder description(String description)

Sets the value of MatchmakingConfigurationProps.getDescription()

Parameters:

description - A human-readable description of the matchmaking configuration.

Returns:

this

notificationTarget

@Stability(Experimental)
public MatchmakingConfigurationProps.Builder notificationTarget(ITopic notificationTarget)

Sets the value of MatchmakingConfigurationProps.getNotificationTarget()

Parameters:

notificationTarget - An SNS topic ARN that is set up to receive matchmaking notifications.

Returns:

this

requestTimeout

@Stability(Experimental)
public MatchmakingConfigurationProps.Builder requestTimeout(Duration requestTimeout)

Sets the value of MatchmakingConfigurationProps.getRequestTimeout()

Parameters:

requestTimeout - The maximum duration, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

Returns:

this

requireAcceptance

@Stability(Experimental)
public MatchmakingConfigurationProps.Builder requireAcceptance(Boolean requireAcceptance)

Sets the value of MatchmakingConfigurationProps.getRequireAcceptance()

Parameters:

requireAcceptance - A flag that determines whether a match that was created with this configuration must be accepted by the matched players. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

Returns:

this

build

@Stability(Experimental)
public MatchmakingConfigurationProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<MatchmakingConfigurationProps>

Returns:

a new instance of MatchmakingConfigurationProps

Throws:

NullPointerException - if any required attribute was not provided