software.amazon.awscdk.services.gamelift

Class CfnMatchmakingRuleSet

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

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.494Z")
 @Stability(value=Stable)
public class CfnMatchmakingRuleSet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GameLift::MatchmakingRuleSet`.

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax.

Learn more

• Build a rule set
• Design a matchmaker
• Matchmaking with FlexMatch

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.*;
 CfnMatchmakingRuleSet cfnMatchmakingRuleSet = CfnMatchmakingRuleSet.Builder.create(this, "MyCfnMatchmakingRuleSet")
         .name("name")
         .ruleSetBody("ruleSetBody")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMatchmakingRuleSet.Builder A fluent builder for CfnMatchmakingRuleSet.

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The unique Amazon Resource Name (ARN) assigned to the rule set.
String	getAttrName() The unique name of the rule set.
protected Map<String,Object>	getCfnProperties()
String	getName() A unique identifier for the matchmaking rule set.
String	getRuleSetBody() A collection of matchmaking rules, formatted as a JSON string.
TagManager	getTags() A list of labels to assign to the new matchmaking rule set resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value) A unique identifier for the matchmaking rule set.
void	setRuleSetBody(String value) A collection of matchmaking rules, formatted as a JSON string.

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

CfnMatchmakingRuleSet

protected CfnMatchmakingRuleSet(software.amazon.jsii.JsiiObjectRef objRef)

CfnMatchmakingRuleSet

protected CfnMatchmakingRuleSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMatchmakingRuleSet

@Stability(value=Stable)
public CfnMatchmakingRuleSet(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      CfnMatchmakingRuleSetProps props)

Create a new `AWS::GameLift::MatchmakingRuleSet`.

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) assigned to the rule set.

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

The unique name of the rule set.

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 rule set 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.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

A unique identifier for the matchmaking rule set.

A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A unique identifier for the matchmaking rule set.

A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

getRuleSetBody

@Stability(value=Stable)
 @NotNull
public String getRuleSetBody()

A collection of matchmaking rules, formatted as a JSON string.

Comments are not allowed in JSON, but most elements support a description field.

setRuleSetBody

@Stability(value=Stable)
public void setRuleSetBody(@NotNull
                                                    String value)

A collection of matchmaking rules, formatted as a JSON string.

Comments are not allowed in JSON, but most elements support a description field.