CfnMatchmakingConfiguration (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.gamelift.CfnMatchmakingConfiguration

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.490Z")
 @Stability(value=Stable)
public class CfnMatchmakingConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GameLift::MatchmakingConfiguration`.

The AWS::GameLift::MatchmakingConfiguration resource defines a new matchmaking configuration for use with FlexMatch. Whether you're using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes that are consistent with that configuration.

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.*;
 CfnMatchmakingConfiguration cfnMatchmakingConfiguration = CfnMatchmakingConfiguration.Builder.create(this, "MyCfnMatchmakingConfiguration")
         .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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnMatchmakingConfiguration.Builder` A fluent builder for `CfnMatchmakingConfiguration`.
`static interface`	`CfnMatchmakingConfiguration.GamePropertyProperty` Set of key-value pairs that contain information about a game session.

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnMatchmakingConfiguration(software.constructs.Construct scope, String id, CfnMatchmakingConfigurationProps props)` Create a new `AWS::GameLift::MatchmakingConfiguration`.
`protected`	`CfnMatchmakingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnMatchmakingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`getAttrArn()` The unique Amazon Resource Name (ARN) for the `MatchmakingConfiguration` .
`String`	`getAttrName()` The `MatchmakingConfiguration` name, which is unique.
`String`	`getBackfillMode()` The method used to backfill game sessions that are created with this matchmaking configuration.
`protected Map<String,Object>`	`getCfnProperties()`
`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.
`TagManager`	`getTags()` A list of labels to assign to the new matchmaking configuration resource.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAcceptanceRequired(Boolean value)` A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
`void`	`setAcceptanceRequired(IResolvable value)` A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
`void`	`setAcceptanceTimeoutSeconds(Number value)` The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
`void`	`setAdditionalPlayerCount(Number value)` The number of player slots in a match to keep open for future players.
`void`	`setBackfillMode(String value)` The method used to backfill game sessions that are created with this matchmaking configuration.
`void`	`setCustomEventData(String value)` Information to add to all events related to the matchmaking configuration.
`void`	`setDescription(String value)` A descriptive label that is associated with matchmaking configuration.
`void`	`setFlexMatchMode(String value)` Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
`void`	`setGameProperties(IResolvable value)` A set of custom properties for a game session, formatted as key-value pairs.
`void`	`setGameProperties(List<Object> value)` A set of custom properties for a game session, formatted as key-value pairs.
`void`	`setGameSessionData(String value)` A set of custom game session properties, formatted as a single string value.
`void`	`setGameSessionQueueArns(List<String> value)` 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.
`void`	`setName(String value)` A unique identifier for the matchmaking configuration.
`void`	`setNotificationTarget(String value)` An SNS topic ARN that is set up to receive matchmaking notifications.
`void`	`setRequestTimeoutSeconds(Number value)` The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
`void`	`setRuleSetName(String value)` A unique identifier for the matchmaking rule set to use with this configuration.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnMatchmakingConfiguration
```
protected CfnMatchmakingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnMatchmakingConfiguration
```
protected CfnMatchmakingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnMatchmakingConfiguration
```
@Stability(value=Stable)
public CfnMatchmakingConfiguration(@NotNull
                                                            software.constructs.Construct scope,
                                                            @NotNull
                                                            String id,
                                                            @NotNull
                                                            CfnMatchmakingConfigurationProps props)
```
    Create a new `AWS::GameLift::MatchmakingConfiguration`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    The unique Amazon Resource Name (ARN) for the `MatchmakingConfiguration` .
  - getAttrName
```
@Stability(value=Stable)
 @NotNull
public String getAttrName()
```
    The `MatchmakingConfiguration` name, which is unique.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    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.
  - getAcceptanceRequired
```
@Stability(value=Stable)
 @NotNull
public 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.
  - setAcceptanceRequired
```
@Stability(value=Stable)
public void setAcceptanceRequired(@NotNull
                                                           Boolean value)
```
    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.
  - setAcceptanceRequired
```
@Stability(value=Stable)
public void setAcceptanceRequired(@NotNull
                                                           IResolvable value)
```
    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
public String getName()
```
    A unique identifier for the matchmaking configuration.
    This name is used to identify the configuration associated with a matchmaking request or ticket.
  - setName
```
@Stability(value=Stable)
public void setName(@NotNull
                                             String value)
```
    A unique identifier for the matchmaking configuration.
    This name is used to identify the configuration associated with a matchmaking request or ticket.
  - getRequestTimeoutSeconds
```
@Stability(value=Stable)
 @NotNull
public 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.
  - setRequestTimeoutSeconds
```
@Stability(value=Stable)
public void setRequestTimeoutSeconds(@NotNull
                                                              Number value)
```
    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
public 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.
  - setRuleSetName
```
@Stability(value=Stable)
public void setRuleSetName(@NotNull
                                                    String value)
```
    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
public Number getAcceptanceTimeoutSeconds()
```
    The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
  - setAcceptanceTimeoutSeconds
```
@Stability(value=Stable)
public void setAcceptanceTimeoutSeconds(@Nullable
                                                                 Number value)
```
    The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
  - getAdditionalPlayerCount
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setAdditionalPlayerCount
```
@Stability(value=Stable)
public void setAdditionalPlayerCount(@Nullable
                                                              Number value)
```
    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
public 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 .
  - setBackfillMode
```
@Stability(value=Stable)
public void setBackfillMode(@Nullable
                                                     String value)
```
    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
public String getCustomEventData()
```
    Information to add to all events related to the matchmaking configuration.
  - setCustomEventData
```
@Stability(value=Stable)
public void setCustomEventData(@Nullable
                                                        String value)
```
    Information to add to all events related to the matchmaking configuration.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
public String getDescription()
```
    A descriptive label that is associated with matchmaking configuration.
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    A descriptive label that is associated with matchmaking configuration.
  - getFlexMatchMode
```
@Stability(value=Stable)
 @Nullable
public String getFlexMatchMode()
```
    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.
  - setFlexMatchMode
```
@Stability(value=Stable)
public void setFlexMatchMode(@Nullable
                                                      String value)
```
    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.
  - getGameProperties
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setGameProperties
```
@Stability(value=Stable)
public void setGameProperties(@Nullable
                                                       IResolvable value)
```
    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 .
  - setGameProperties
```
@Stability(value=Stable)
public void setGameProperties(@Nullable
                                                       List<Object> value)
```
    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
public 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 .
  - setGameSessionData
```
@Stability(value=Stable)
public void setGameSessionData(@Nullable
                                                        String value)
```
    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
public 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.
  - setGameSessionQueueArns
```
@Stability(value=Stable)
public void setGameSessionQueueArns(@Nullable
                                                             List<String> value)
```
    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
public String getNotificationTarget()
```
    An SNS topic ARN that is set up to receive matchmaking notifications.
    See Setting up notifications for matchmaking for more information.
  - setNotificationTarget
```
@Stability(value=Stable)
public void setNotificationTarget(@Nullable
                                                           String value)
```
    An SNS topic ARN that is set up to receive matchmaking notifications.
    See Setting up notifications for matchmaking for more information.

Class CfnMatchmakingConfiguration

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnMatchmakingConfiguration

CfnMatchmakingConfiguration

CfnMatchmakingConfiguration

Method Detail

inspect

renderProperties

getAttrArn

getAttrName

getCfnProperties

getTags

getAcceptanceRequired

setAcceptanceRequired

setAcceptanceRequired

getName

setName

getRequestTimeoutSeconds

setRequestTimeoutSeconds

getRuleSetName

setRuleSetName

getAcceptanceTimeoutSeconds

setAcceptanceTimeoutSeconds

getAdditionalPlayerCount

setAdditionalPlayerCount

getBackfillMode

setBackfillMode

getCustomEventData

setCustomEventData

getDescription

setDescription

getFlexMatchMode

setFlexMatchMode

getGameProperties

setGameProperties

setGameProperties

getGameSessionData

setGameSessionData

getGameSessionQueueArns

setGameSessionQueueArns

getNotificationTarget

setNotificationTarget