Package software.amazon.awscdk.services.gamelift

Class CfnMatchmakingConfigurationProps.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnMatchmakingConfigurationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMatchmakingConfigurationProps>

Enclosing interface:

CfnMatchmakingConfigurationProps

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

A builder for CfnMatchmakingConfigurationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnMatchmakingConfigurationProps.Builder	acceptanceRequired(Boolean acceptanceRequired)	Sets the value of CfnMatchmakingConfigurationProps.getAcceptanceRequired()
CfnMatchmakingConfigurationProps.Builder	acceptanceRequired(IResolvable acceptanceRequired)	Sets the value of CfnMatchmakingConfigurationProps.getAcceptanceRequired()
CfnMatchmakingConfigurationProps.Builder	acceptanceTimeoutSeconds(Number acceptanceTimeoutSeconds)	Sets the value of CfnMatchmakingConfigurationProps.getAcceptanceTimeoutSeconds()
CfnMatchmakingConfigurationProps.Builder	additionalPlayerCount(Number additionalPlayerCount)	Sets the value of CfnMatchmakingConfigurationProps.getAdditionalPlayerCount()
CfnMatchmakingConfigurationProps.Builder	backfillMode(String backfillMode)	Sets the value of CfnMatchmakingConfigurationProps.getBackfillMode()
CfnMatchmakingConfigurationProps	build()	Builds the configured instance.
CfnMatchmakingConfigurationProps.Builder	customEventData(String customEventData)	Sets the value of CfnMatchmakingConfigurationProps.getCustomEventData()
CfnMatchmakingConfigurationProps.Builder	description(String description)	Sets the value of CfnMatchmakingConfigurationProps.getDescription()
CfnMatchmakingConfigurationProps.Builder	flexMatchMode(String flexMatchMode)	Sets the value of CfnMatchmakingConfigurationProps.getFlexMatchMode()
CfnMatchmakingConfigurationProps.Builder	gameProperties(List<? extends Object> gameProperties)	Sets the value of CfnMatchmakingConfigurationProps.getGameProperties()
CfnMatchmakingConfigurationProps.Builder	gameProperties(IResolvable gameProperties)	Sets the value of CfnMatchmakingConfigurationProps.getGameProperties()
CfnMatchmakingConfigurationProps.Builder	gameSessionData(String gameSessionData)	Sets the value of CfnMatchmakingConfigurationProps.getGameSessionData()
CfnMatchmakingConfigurationProps.Builder	gameSessionQueueArns(List<String> gameSessionQueueArns)	Sets the value of CfnMatchmakingConfigurationProps.getGameSessionQueueArns()
CfnMatchmakingConfigurationProps.Builder	name(String name)	Sets the value of CfnMatchmakingConfigurationProps.getName()
CfnMatchmakingConfigurationProps.Builder	notificationTarget(String notificationTarget)	Sets the value of CfnMatchmakingConfigurationProps.getNotificationTarget()
CfnMatchmakingConfigurationProps.Builder	requestTimeoutSeconds(Number requestTimeoutSeconds)	Sets the value of CfnMatchmakingConfigurationProps.getRequestTimeoutSeconds()
CfnMatchmakingConfigurationProps.Builder	ruleSetName(String ruleSetName)	Sets the value of CfnMatchmakingConfigurationProps.getRuleSetName()
CfnMatchmakingConfigurationProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnMatchmakingConfigurationProps.getTags()

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

acceptanceRequired

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder acceptanceRequired(Boolean acceptanceRequired)

Sets the value of CfnMatchmakingConfigurationProps.getAcceptanceRequired()

Parameters:

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.

Returns:

this

acceptanceRequired

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder acceptanceRequired(IResolvable acceptanceRequired)

Sets the value of CfnMatchmakingConfigurationProps.getAcceptanceRequired()

Parameters:

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.

Returns:

this

name

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder name(String name)

Sets the value of CfnMatchmakingConfigurationProps.getName()

Parameters:

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.

Returns:

this

requestTimeoutSeconds

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder requestTimeoutSeconds(Number requestTimeoutSeconds)

Sets the value of CfnMatchmakingConfigurationProps.getRequestTimeoutSeconds()

Parameters:

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.

Returns:

this

ruleSetName

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder ruleSetName(String ruleSetName)

Sets the value of CfnMatchmakingConfigurationProps.getRuleSetName()

Parameters:

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.

Returns:

this

acceptanceTimeoutSeconds

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder acceptanceTimeoutSeconds(Number acceptanceTimeoutSeconds)

Sets the value of CfnMatchmakingConfigurationProps.getAcceptanceTimeoutSeconds()

Parameters:

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

Returns:

this

additionalPlayerCount

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder additionalPlayerCount(Number additionalPlayerCount)

Sets the value of CfnMatchmakingConfigurationProps.getAdditionalPlayerCount()

Parameters:

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 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 FlexMatchMode is set to STANDALONE .

Returns:

this

backfillMode

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder backfillMode(String backfillMode)

Sets the value of CfnMatchmakingConfigurationProps.getBackfillMode()

Parameters:

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 .

Returns:

this

customEventData

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder customEventData(String customEventData)

Sets the value of CfnMatchmakingConfigurationProps.getCustomEventData()

Parameters:

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

Returns:

this

description

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder description(String description)

Sets the value of CfnMatchmakingConfigurationProps.getDescription()

Parameters:

description - A description for the matchmaking configuration.

Returns:

this

flexMatchMode

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder flexMatchMode(String flexMatchMode)

Sets the value of CfnMatchmakingConfigurationProps.getFlexMatchMode()

Parameters:

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

Returns:

this

gameProperties

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder gameProperties(IResolvable gameProperties)

Sets the value of CfnMatchmakingConfigurationProps.getGameProperties()

Parameters:

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 .

Returns:

this

gameProperties

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder gameProperties(List<? extends Object> gameProperties)

Sets the value of CfnMatchmakingConfigurationProps.getGameProperties()

Parameters:

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 .

Returns:

this

gameSessionData

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder gameSessionData(String gameSessionData)

Sets the value of CfnMatchmakingConfigurationProps.getGameSessionData()

Parameters:

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 .

Returns:

this

gameSessionQueueArns

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder gameSessionQueueArns(List<String> gameSessionQueueArns)

Sets the value of CfnMatchmakingConfigurationProps.getGameSessionQueueArns()

Parameters:

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.

Returns:

this

notificationTarget

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder notificationTarget(String notificationTarget)

Sets the value of CfnMatchmakingConfigurationProps.getNotificationTarget()

Parameters:

notificationTarget - An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.

Returns:

this

tags

@Stability(Stable)
public CfnMatchmakingConfigurationProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnMatchmakingConfigurationProps.getTags()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnMatchmakingConfigurationProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnMatchmakingConfigurationProps

Throws:

NullPointerException - if any required attribute was not provided