software.amazon.awscdk.services.gamelift

Class CfnMatchmakingConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnMatchmakingConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMatchmakingConfiguration>

Enclosing class:

CfnMatchmakingConfiguration

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

A fluent builder for CfnMatchmakingConfiguration.

Method Summary

Modifier and Type	Method and Description
CfnMatchmakingConfiguration.Builder	acceptanceRequired(Boolean acceptanceRequired) A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
CfnMatchmakingConfiguration.Builder	acceptanceRequired(IResolvable acceptanceRequired) A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
CfnMatchmakingConfiguration.Builder	acceptanceTimeoutSeconds(Number acceptanceTimeoutSeconds) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
CfnMatchmakingConfiguration.Builder	additionalPlayerCount(Number additionalPlayerCount) The number of player slots in a match to keep open for future players.
CfnMatchmakingConfiguration.Builder	backfillMode(String backfillMode) The method used to backfill game sessions that are created with this matchmaking configuration.
CfnMatchmakingConfiguration	build()
static CfnMatchmakingConfiguration.Builder	create(software.constructs.Construct scope, String id)
CfnMatchmakingConfiguration.Builder	customEventData(String customEventData) Information to add to all events related to the matchmaking configuration.
CfnMatchmakingConfiguration.Builder	description(String description) A descriptive label that is associated with matchmaking configuration.
CfnMatchmakingConfiguration.Builder	flexMatchMode(String flexMatchMode) Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
CfnMatchmakingConfiguration.Builder	gameProperties(IResolvable gameProperties) A set of custom properties for a game session, formatted as key-value pairs.
CfnMatchmakingConfiguration.Builder	gameProperties(List<? extends Object> gameProperties) A set of custom properties for a game session, formatted as key-value pairs.
CfnMatchmakingConfiguration.Builder	gameSessionData(String gameSessionData) A set of custom game session properties, formatted as a single string value.
CfnMatchmakingConfiguration.Builder	gameSessionQueueArns(List<String> 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.
CfnMatchmakingConfiguration.Builder	name(String name) A unique identifier for the matchmaking configuration.
CfnMatchmakingConfiguration.Builder	notificationTarget(String notificationTarget) An SNS topic ARN that is set up to receive matchmaking notifications.
CfnMatchmakingConfiguration.Builder	requestTimeoutSeconds(Number requestTimeoutSeconds) The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
CfnMatchmakingConfiguration.Builder	ruleSetName(String ruleSetName) A unique identifier for the matchmaking rule set to use with this configuration.
CfnMatchmakingConfiguration.Builder	tags(List<? extends CfnTag> tags) A list of labels to assign to the new matchmaking configuration resource.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnMatchmakingConfiguration.Builder create(software.constructs.Construct scope,
                                                                                  String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnMatchmakingConfiguration.GamePropertyProperty.Builder.

acceptanceRequired

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder acceptanceRequired(Boolean acceptanceRequired)

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 status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

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.

Returns:

this

acceptanceRequired

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder acceptanceRequired(IResolvable acceptanceRequired)

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 status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

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.

Returns:

this

name

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder name(String name)

A unique identifier for the matchmaking configuration.

This name is used to identify the configuration associated with a matchmaking request or ticket.

Parameters:

name - A unique identifier for the matchmaking configuration. This parameter is required.

Returns:

this

requestTimeoutSeconds

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder requestTimeoutSeconds(Number requestTimeoutSeconds)

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.

Parameters:

requestTimeoutSeconds - The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. This parameter is required.

Returns:

this

ruleSetName

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder ruleSetName(String ruleSetName)

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.

Parameters:

ruleSetName - A unique identifier for the matchmaking rule set to use with this configuration. This parameter is required.

Returns:

this

acceptanceTimeoutSeconds

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder acceptanceTimeoutSeconds(Number acceptanceTimeoutSeconds)

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

Parameters:

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

Returns:

this

additionalPlayerCount

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder additionalPlayerCount(Number 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 .

Parameters:

additionalPlayerCount - The number of player slots in a match to keep open for future players. This parameter is required.

Returns:

this

backfillMode

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder backfillMode(String 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 .

Parameters:

backfillMode - The method used to backfill game sessions that are created with this matchmaking configuration. This parameter is required.

Returns:

this

customEventData

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder customEventData(String customEventData)

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

Parameters:

customEventData - Information to add to all events related to the matchmaking configuration. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder description(String description)

A descriptive label that is associated with matchmaking configuration.

Parameters:

description - A descriptive label that is associated with matchmaking configuration. This parameter is required.

Returns:

this

flexMatchMode

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder flexMatchMode(String flexMatchMode)

Indicates whether this matchmaking configuration is being used with 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 GameLift queue to start a game session for the match.

Parameters:

flexMatchMode - Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. This parameter is required.

Returns:

this

gameProperties

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder gameProperties(IResolvable 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 .

Parameters:

gameProperties - A set of custom properties for a game session, formatted as key-value pairs. This parameter is required.

Returns:

this

gameProperties

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder gameProperties(List<? extends Object> 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 .

Parameters:

gameProperties - A set of custom properties for a game session, formatted as key-value pairs. This parameter is required.

Returns:

this

gameSessionData

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder gameSessionData(String 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 .

Parameters:

gameSessionData - A set of custom game session properties, formatted as a single string value. This parameter is required.

Returns:

this

gameSessionQueueArns

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder gameSessionQueueArns(List<String> 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:::gamesessionqueue/` . Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter.

Parameters:

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:::gamesessionqueue/` . Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If `FlexMatchMode` is set to `STANDALONE` , do not set this parameter. This parameter is required.

Returns:

this

notificationTarget

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder notificationTarget(String notificationTarget)

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

See Setting up notifications for matchmaking for more information.

Parameters:

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

Returns:

this

tags

@Stability(value=Stable)
public CfnMatchmakingConfiguration.Builder tags(List<? extends CfnTag> 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.

Parameters:

tags - A list of labels to assign to the new matchmaking configuration resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnMatchmakingConfiguration build()

Specified by:

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