software.amazon.awscdk.services.gamelift

Class CfnMatchmakingConfigurationProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.gamelift.CfnMatchmakingConfigurationProps.Jsii$Proxy

All Implemented Interfaces:

CfnMatchmakingConfigurationProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnMatchmakingConfigurationProps

@Stability(value=Stable)
 @Internal
public static final class CfnMatchmakingConfigurationProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnMatchmakingConfigurationProps

An implementation for CfnMatchmakingConfigurationProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.CfnMatchmakingConfigurationProps

CfnMatchmakingConfigurationProps.Builder, CfnMatchmakingConfigurationProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(CfnMatchmakingConfigurationProps.Builder builder) Constructor that initializes the object based on literal property values passed by the CfnMatchmakingConfigurationProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Object	getAcceptanceRequired() A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
Number	getAcceptanceTimeoutSeconds() The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
Number	getAdditionalPlayerCount() The number of player slots in a match to keep open for future players.
String	getBackfillMode() The method used to backfill game sessions that are created with this matchmaking configuration.
String	getCustomEventData() Information to add to all events related to the matchmaking configuration.
String	getDescription() A descriptive label that is associated with matchmaking configuration.
String	getFlexMatchMode() Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
Object	getGameProperties() A set of custom properties for a game session, formatted as key-value pairs.
String	getGameSessionData() A set of custom game session properties, formatted as a single string value.
List<String>	getGameSessionQueueArns() 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.
String	getName() A unique identifier for the matchmaking configuration.
String	getNotificationTarget() An SNS topic ARN that is set up to receive matchmaking notifications.
Number	getRequestTimeoutSeconds() The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
String	getRuleSetName() A unique identifier for the matchmaking rule set to use with this configuration.
List<CfnTag>	getTags() A list of labels to assign to the new matchmaking configuration resource.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.gamelift.CfnMatchmakingConfigurationProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnMatchmakingConfigurationProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnMatchmakingConfigurationProps.Builder.

Method Detail

getAcceptanceRequired

public final Object getAcceptanceRequired()

Description copied from interface: CfnMatchmakingConfigurationProps

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.

Specified by:

getAcceptanceRequired in interface CfnMatchmakingConfigurationProps

getName

public final String getName()

Description copied from interface: CfnMatchmakingConfigurationProps

A unique identifier for the matchmaking configuration.

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

Specified by:

getName in interface CfnMatchmakingConfigurationProps

getRequestTimeoutSeconds

public final Number getRequestTimeoutSeconds()

Description copied from interface: CfnMatchmakingConfigurationProps

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.

Specified by:

getRequestTimeoutSeconds in interface CfnMatchmakingConfigurationProps

getRuleSetName

public final String getRuleSetName()

Description copied from interface: CfnMatchmakingConfigurationProps

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.

Specified by:

getRuleSetName in interface CfnMatchmakingConfigurationProps

getAcceptanceTimeoutSeconds

public final Number getAcceptanceTimeoutSeconds()

Description copied from interface: CfnMatchmakingConfigurationProps

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

Specified by:

getAcceptanceTimeoutSeconds in interface CfnMatchmakingConfigurationProps

getAdditionalPlayerCount

public final Number getAdditionalPlayerCount()

Description copied from interface: CfnMatchmakingConfigurationProps

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 .

Specified by:

getAdditionalPlayerCount in interface CfnMatchmakingConfigurationProps

getBackfillMode

public final String getBackfillMode()

Description copied from interface: CfnMatchmakingConfigurationProps

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 .

Specified by:

getBackfillMode in interface CfnMatchmakingConfigurationProps

getCustomEventData

public final String getCustomEventData()

Description copied from interface: CfnMatchmakingConfigurationProps

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

Specified by:

getCustomEventData in interface CfnMatchmakingConfigurationProps

getDescription

public final String getDescription()

Description copied from interface: CfnMatchmakingConfigurationProps

A descriptive label that is associated with matchmaking configuration.

Specified by:

getDescription in interface CfnMatchmakingConfigurationProps

getFlexMatchMode

public final String getFlexMatchMode()

Description copied from interface: CfnMatchmakingConfigurationProps

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.

Specified by:

getFlexMatchMode in interface CfnMatchmakingConfigurationProps

getGameProperties

public final Object getGameProperties()

Description copied from interface: CfnMatchmakingConfigurationProps

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 .

Specified by:

getGameProperties in interface CfnMatchmakingConfigurationProps

getGameSessionData

public final String getGameSessionData()

Description copied from interface: CfnMatchmakingConfigurationProps

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 .

Specified by:

getGameSessionData in interface CfnMatchmakingConfigurationProps

getGameSessionQueueArns

public final List<String> getGameSessionQueueArns()

Description copied from interface: CfnMatchmakingConfigurationProps

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.

Specified by:

getGameSessionQueueArns in interface CfnMatchmakingConfigurationProps

getNotificationTarget

public final String getNotificationTarget()

Description copied from interface: CfnMatchmakingConfigurationProps

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

See Setting up notifications for matchmaking for more information.

Specified by:

getNotificationTarget in interface CfnMatchmakingConfigurationProps

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnMatchmakingConfigurationProps

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.

Specified by:

getTags in interface CfnMatchmakingConfigurationProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object