software.amazon.awssdk.services.gamelift.model

Interface CreateMatchmakingConfigurationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateMatchmakingConfigurationRequest.Builder,CreateMatchmakingConfigurationRequest>, GameLiftRequest.Builder, SdkBuilder<CreateMatchmakingConfigurationRequest.Builder,CreateMatchmakingConfigurationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateMatchmakingConfigurationRequest

public static interface CreateMatchmakingConfigurationRequest.Builder
extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<CreateMatchmakingConfigurationRequest.Builder,CreateMatchmakingConfigurationRequest>

Method Summary

Modifier and Type	Method and Description
CreateMatchmakingConfigurationRequest.Builder	acceptanceRequired(Boolean acceptanceRequired) A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
CreateMatchmakingConfigurationRequest.Builder	acceptanceTimeoutSeconds(Integer acceptanceTimeoutSeconds) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
CreateMatchmakingConfigurationRequest.Builder	additionalPlayerCount(Integer additionalPlayerCount) The number of player slots in a match to keep open for future players.
CreateMatchmakingConfigurationRequest.Builder	backfillMode(BackfillMode backfillMode) The method used to backfill game sessions that are created with this matchmaking configuration.
CreateMatchmakingConfigurationRequest.Builder	backfillMode(String backfillMode) The method used to backfill game sessions that are created with this matchmaking configuration.
CreateMatchmakingConfigurationRequest.Builder	customEventData(String customEventData) Information to be added to all events related to this matchmaking configuration.
CreateMatchmakingConfigurationRequest.Builder	description(String description) A human-readable description of the matchmaking configuration.
CreateMatchmakingConfigurationRequest.Builder	flexMatchMode(FlexMatchMode flexMatchMode) Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
CreateMatchmakingConfigurationRequest.Builder	flexMatchMode(String flexMatchMode) Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
CreateMatchmakingConfigurationRequest.Builder	gameProperties(Collection<GameProperty> gameProperties) A set of custom properties for a game session, formatted as key:value pairs.
CreateMatchmakingConfigurationRequest.Builder	gameProperties(Consumer<GameProperty.Builder>... gameProperties) A set of custom properties for a game session, formatted as key:value pairs.
CreateMatchmakingConfigurationRequest.Builder	gameProperties(GameProperty... gameProperties) A set of custom properties for a game session, formatted as key:value pairs.
CreateMatchmakingConfigurationRequest.Builder	gameSessionData(String gameSessionData) A set of custom game session properties, formatted as a single string value.
CreateMatchmakingConfigurationRequest.Builder	gameSessionQueueArns(Collection<String> gameSessionQueueArns) The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it.
CreateMatchmakingConfigurationRequest.Builder	gameSessionQueueArns(String... gameSessionQueueArns) The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it.
CreateMatchmakingConfigurationRequest.Builder	name(String name) A unique identifier for the matchmaking configuration.
CreateMatchmakingConfigurationRequest.Builder	notificationTarget(String notificationTarget) An SNS topic ARN that is set up to receive matchmaking notifications.
CreateMatchmakingConfigurationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateMatchmakingConfigurationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateMatchmakingConfigurationRequest.Builder	requestTimeoutSeconds(Integer requestTimeoutSeconds) The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
CreateMatchmakingConfigurationRequest.Builder	ruleSetName(String ruleSetName) A unique identifier for the matchmaking rule set to use with this configuration.
CreateMatchmakingConfigurationRequest.Builder	tags(Collection<Tag> tags) A list of labels to assign to the new matchmaking configuration resource.
CreateMatchmakingConfigurationRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of labels to assign to the new matchmaking configuration resource.
CreateMatchmakingConfigurationRequest.Builder	tags(Tag... tags) A list of labels to assign to the new matchmaking configuration resource.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

CreateMatchmakingConfigurationRequest.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 name is used to identify the configuration associated with a matchmaking request or ticket.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateMatchmakingConfigurationRequest.Builder description(String description)

A human-readable description of the matchmaking configuration.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

gameSessionQueueArns

CreateMatchmakingConfigurationRequest.Builder gameSessionQueueArns(Collection<String> gameSessionQueueArns)

The Amazon Resource Name (ARN) 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:<region>::gamesessionqueue/<queue name>. 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) 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:<region>::gamesessionqueue/<queue name>. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

gameSessionQueueArns

CreateMatchmakingConfigurationRequest.Builder gameSessionQueueArns(String... gameSessionQueueArns)

The Amazon Resource Name (ARN) 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:<region>::gamesessionqueue/<queue name>. 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) 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:<region>::gamesessionqueue/<queue name>. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestTimeoutSeconds

CreateMatchmakingConfigurationRequest.Builder requestTimeoutSeconds(Integer 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. Requests that fail due to timing out can be resubmitted as needed.

Returns:

Returns a reference to this object so that method calls can be chained together.

acceptanceTimeoutSeconds

CreateMatchmakingConfigurationRequest.Builder acceptanceTimeoutSeconds(Integer 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

acceptanceRequired

CreateMatchmakingConfigurationRequest.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. 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:

Returns a reference to this object so that method calls can be chained together.

ruleSetName

CreateMatchmakingConfigurationRequest.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. 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:

Returns a reference to this object so that method calls can be chained together.

notificationTarget

CreateMatchmakingConfigurationRequest.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. See Setting up notifications for matchmaking for more information.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalPlayerCount

CreateMatchmakingConfigurationRequest.Builder additionalPlayerCount(Integer 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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

customEventData

CreateMatchmakingConfigurationRequest.Builder customEventData(String customEventData)

Information to be added to all events related to this matchmaking configuration.

Parameters:

customEventData - Information to be added to all events related to this matchmaking configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

gameProperties

CreateMatchmakingConfigurationRequest.Builder gameProperties(Collection<GameProperty> gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. 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. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

Returns:

Returns a reference to this object so that method calls can be chained together.

gameProperties

CreateMatchmakingConfigurationRequest.Builder gameProperties(GameProperty... gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. 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. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

Returns:

Returns a reference to this object so that method calls can be chained together.

gameProperties

CreateMatchmakingConfigurationRequest.Builder gameProperties(Consumer<GameProperty.Builder>... gameProperties)

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #gameProperties(List).

Parameters:

gameProperties - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#gameProperties(List)

gameSessionData

CreateMatchmakingConfigurationRequest.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 in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. 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 data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

Returns:

Returns a reference to this object so that method calls can be chained together.

backfillMode

CreateMatchmakingConfigurationRequest.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. 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:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackfillMode, BackfillMode

backfillMode

CreateMatchmakingConfigurationRequest.Builder backfillMode(BackfillMode 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. 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:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackfillMode, BackfillMode

flexMatchMode

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FlexMatchMode, FlexMatchMode

flexMatchMode

CreateMatchmakingConfigurationRequest.Builder flexMatchMode(FlexMatchMode 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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FlexMatchMode, FlexMatchMode

tags

CreateMatchmakingConfigurationRequest.Builder tags(Collection<Tag> 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. 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:

Returns a reference to this object so that method calls can be chained together.

tags

CreateMatchmakingConfigurationRequest.Builder tags(Tag... 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. 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:

Returns a reference to this object so that method calls can be chained together.

tags

CreateMatchmakingConfigurationRequest.Builder tags(Consumer<Tag.Builder>... 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 is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

overrideConfiguration

CreateMatchmakingConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateMatchmakingConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder