CfnMatchmakingConfigurationProps (software.amazon.awscdk:monocdk 1.138.0.DEVPREVIEW API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnMatchmakingConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:09.364Z")
 @Stability(value=Stable)
public interface CfnMatchmakingConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnMatchmakingConfiguration`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 CfnMatchmakingConfigurationProps cfnMatchmakingConfigurationProps = CfnMatchmakingConfigurationProps.builder()
         .acceptanceRequired(false)
         .name("name")
         .requestTimeoutSeconds(123)
         .ruleSetName("ruleSetName")
         // the properties below are optional
         .acceptanceTimeoutSeconds(123)
         .additionalPlayerCount(123)
         .backfillMode("backfillMode")
         .customEventData("customEventData")
         .description("description")
         .flexMatchMode("flexMatchMode")
         .gameProperties(List.of(GamePropertyProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .gameSessionData("gameSessionData")
         .gameSessionQueueArns(List.of("gameSessionQueueArns"))
         .notificationTarget("notificationTarget")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnMatchmakingConfigurationProps.Builder` A builder for `CfnMatchmakingConfigurationProps`
`static class`	`CfnMatchmakingConfigurationProps.Jsii$Proxy` An implementation for `CfnMatchmakingConfigurationProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnMatchmakingConfigurationProps.Builder`	`builder()`
`Object`	`getAcceptanceRequired()` A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
`default Number`	`getAcceptanceTimeoutSeconds()` The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
`default Number`	`getAdditionalPlayerCount()` The number of player slots in a match to keep open for future players.
`default String`	`getBackfillMode()` The method used to backfill game sessions that are created with this matchmaking configuration.
`default String`	`getCustomEventData()` Information that is attached to all events related to the matchmaking configuration.
`default String`	`getDescription()` A descriptive label that is associated with matchmaking configuration.
`default String`	`getFlexMatchMode()` Indicates whether this matchmaking configuration is being used with GameLift managed hosting or as a standalone matchmaking solution.
`default Object`	`getGameProperties()` A set of custom properties for a game session, formatted as key-value pairs.
`default String`	`getGameSessionData()` A set of custom game session properties, formatted as a single string value.
`default 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 a matchmaking configuration.
`default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getAcceptanceRequired
```
@Stability(value=Stable)
 @NotNull
Object getAcceptanceRequired()
```
    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.
  - getName
```
@Stability(value=Stable)
 @NotNull
String getName()
```
    A unique identifier for a matchmaking configuration.
    Matchmaking requests use this name to identify which matchmaking configuration to use.
  - getRequestTimeoutSeconds
```
@Stability(value=Stable)
 @NotNull
Number getRequestTimeoutSeconds()
```
    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.
  - getRuleSetName
```
@Stability(value=Stable)
 @NotNull
String getRuleSetName()
```
    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.
  - getAcceptanceTimeoutSeconds
```
@Stability(value=Stable)
 @Nullable
default Number getAcceptanceTimeoutSeconds()
```
    The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
  - getAdditionalPlayerCount
```
@Stability(value=Stable)
 @Nullable
default Number getAdditionalPlayerCount()
```
    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 .
  - getBackfillMode
```
@Stability(value=Stable)
 @Nullable
default String getBackfillMode()
```
    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 .
  - getCustomEventData
```
@Stability(value=Stable)
 @Nullable
default String getCustomEventData()
```
    Information that is attached to all events related to the matchmaking configuration.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
default String getDescription()
```
    A descriptive label that is associated with matchmaking configuration.
  - getFlexMatchMode
```
@Stability(value=Stable)
 @Nullable
default String getFlexMatchMode()
```
    Indicates whether this matchmaking configuration is being used with GameLift managed 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.
  - getGameProperties
```
@Stability(value=Stable)
 @Nullable
default Object getGameProperties()
```
    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 .
  - getGameSessionData
```
@Stability(value=Stable)
 @Nullable
default String getGameSessionData()
```
    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 .
  - getGameSessionQueueArns
```
@Stability(value=Stable)
 @Nullable
default 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. 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.
  - getNotificationTarget
```
@Stability(value=Stable)
 @Nullable
default String getNotificationTarget()
```
    An SNS topic ARN that is set up to receive matchmaking notifications.
    See Setting up notifications for matchmaking for more information.
  - builder
```
@Stability(value=Stable)
static CfnMatchmakingConfigurationProps.Builder builder()
```
    Returns:
    
    a CfnMatchmakingConfigurationProps.Builder of CfnMatchmakingConfigurationProps

Interface CfnMatchmakingConfigurationProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getAcceptanceRequired

getName

getRequestTimeoutSeconds

getRuleSetName

getAcceptanceTimeoutSeconds

getAdditionalPlayerCount

getBackfillMode

getCustomEventData

getDescription

getFlexMatchMode

getGameProperties

getGameSessionData

getGameSessionQueueArns

getNotificationTarget

builder