Package software.amazon.awscdk.services.gamelift

Interface CfnMatchmakingRuleSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMatchmakingRuleSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:10.620Z")
@Stability(Stable)
public interface CfnMatchmakingRuleSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMatchmakingRuleSet.

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.*;
 CfnMatchmakingRuleSetProps cfnMatchmakingRuleSetProps = CfnMatchmakingRuleSetProps.builder()
         .name("name")
         .ruleSetBody("ruleSetBody")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMatchmakingRuleSetProps.Builder	A builder for CfnMatchmakingRuleSetProps
static final class	CfnMatchmakingRuleSetProps.Jsii$Proxy	An implementation for CfnMatchmakingRuleSetProps

Method Summary

Modifier and Type	Method	Description
static CfnMatchmakingRuleSetProps.Builder	builder()
String	getName()	A unique identifier for the matchmaking rule set.
String	getRuleSetBody()	A collection of matchmaking rules, formatted as a JSON string.
default List<CfnTag>	getTags()	A list of labels to assign to the new matchmaking rule set resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-name

getRuleSetBody

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-rulesetbody

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-matchmakingruleset.html#cfn-gamelift-matchmakingruleset-tags

builder

@Stability(Stable)
static CfnMatchmakingRuleSetProps.Builder builder()

Returns:

a CfnMatchmakingRuleSetProps.Builder of CfnMatchmakingRuleSetProps