| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.GameLift.CreateMatchmakingRuleSet
Description
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. A rule set is used by a MatchmakingConfiguration.
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 using ValidateMatchmakingRuleSet before creating a new rule set.
Learn more
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
Synopsis
- data CreateMatchmakingRuleSet = CreateMatchmakingRuleSet' {}
- newCreateMatchmakingRuleSet :: Text -> Text -> CreateMatchmakingRuleSet
- createMatchmakingRuleSet_tags :: Lens' CreateMatchmakingRuleSet (Maybe [Tag])
- createMatchmakingRuleSet_name :: Lens' CreateMatchmakingRuleSet Text
- createMatchmakingRuleSet_ruleSetBody :: Lens' CreateMatchmakingRuleSet Text
- data CreateMatchmakingRuleSetResponse = CreateMatchmakingRuleSetResponse' {}
- newCreateMatchmakingRuleSetResponse :: Int -> MatchmakingRuleSet -> CreateMatchmakingRuleSetResponse
- createMatchmakingRuleSetResponse_httpStatus :: Lens' CreateMatchmakingRuleSetResponse Int
- createMatchmakingRuleSetResponse_ruleSet :: Lens' CreateMatchmakingRuleSetResponse MatchmakingRuleSet
Creating a Request
data CreateMatchmakingRuleSet Source #
Represents the input for a request operation.
See: newCreateMatchmakingRuleSet smart constructor.
Constructors
| CreateMatchmakingRuleSet' | |
Fields
| |
Instances
newCreateMatchmakingRuleSet Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateMatchmakingRuleSet |
Create a value of CreateMatchmakingRuleSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateMatchmakingRuleSet', createMatchmakingRuleSet_tags - 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.
$sel:name:CreateMatchmakingRuleSet', createMatchmakingRuleSet_name - 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.
$sel:ruleSetBody:CreateMatchmakingRuleSet', createMatchmakingRuleSet_ruleSetBody - A collection of matchmaking rules, formatted as a JSON string. Comments
are not allowed in JSON, but most elements support a description field.
Request Lenses
createMatchmakingRuleSet_tags :: Lens' CreateMatchmakingRuleSet (Maybe [Tag]) Source #
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.
createMatchmakingRuleSet_name :: Lens' CreateMatchmakingRuleSet Text Source #
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.
createMatchmakingRuleSet_ruleSetBody :: Lens' CreateMatchmakingRuleSet Text Source #
A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
Destructuring the Response
data CreateMatchmakingRuleSetResponse Source #
Represents the returned data in response to a request operation.
See: newCreateMatchmakingRuleSetResponse smart constructor.
Constructors
| CreateMatchmakingRuleSetResponse' | |
Fields
| |
Instances
newCreateMatchmakingRuleSetResponse Source #
Arguments
| :: Int | |
| -> MatchmakingRuleSet | |
| -> CreateMatchmakingRuleSetResponse |
Create a value of CreateMatchmakingRuleSetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateMatchmakingRuleSetResponse', createMatchmakingRuleSetResponse_httpStatus - The response's http status code.
$sel:ruleSet:CreateMatchmakingRuleSetResponse', createMatchmakingRuleSetResponse_ruleSet - The newly created matchmaking rule set.
Response Lenses
createMatchmakingRuleSetResponse_httpStatus :: Lens' CreateMatchmakingRuleSetResponse Int Source #
The response's http status code.
createMatchmakingRuleSetResponse_ruleSet :: Lens' CreateMatchmakingRuleSetResponse MatchmakingRuleSet Source #
The newly created matchmaking rule set.