1. Packages
  2. AWS
  3. API Docs
  4. gamelift
  5. MatchmakingRuleSet
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi

aws.gamelift.MatchmakingRuleSet

Explore with Pulumi AI

Deprecated: This resource will be removed in the next major version.Consider using https://www.pulumi.com/registry/packages/aws-native/api-docs/gamelift/matchmakingruleset/ instead

Provides a GameLift Matchmaking Rule Set resources.

Create MatchmakingRuleSet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MatchmakingRuleSet(name: string, args: MatchmakingRuleSetArgs, opts?: CustomResourceOptions);
@overload
def MatchmakingRuleSet(resource_name: str,
                       args: MatchmakingRuleSetArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def MatchmakingRuleSet(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       name: Optional[str] = None,
                       rule_set_body: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
func NewMatchmakingRuleSet(ctx *Context, name string, args MatchmakingRuleSetArgs, opts ...ResourceOption) (*MatchmakingRuleSet, error)
public MatchmakingRuleSet(string name, MatchmakingRuleSetArgs args, CustomResourceOptions? opts = null)
public MatchmakingRuleSet(String name, MatchmakingRuleSetArgs args)
public MatchmakingRuleSet(String name, MatchmakingRuleSetArgs args, CustomResourceOptions options)
type: aws:gamelift:MatchmakingRuleSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MatchmakingRuleSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MatchmakingRuleSetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MatchmakingRuleSetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MatchmakingRuleSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MatchmakingRuleSetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

MatchmakingRuleSet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MatchmakingRuleSet resource accepts the following input properties:

RuleSetBody
This property is required.
Changes to this property will trigger replacement.
string
JSON encoded string containing rule set data.
Name Changes to this property will trigger replacement. string
Name of the matchmaking rule set.
Tags Dictionary<string, string>
RuleSetBody
This property is required.
Changes to this property will trigger replacement.
string
JSON encoded string containing rule set data.
Name Changes to this property will trigger replacement. string
Name of the matchmaking rule set.
Tags map[string]string
ruleSetBody
This property is required.
Changes to this property will trigger replacement.
String
JSON encoded string containing rule set data.
name Changes to this property will trigger replacement. String
Name of the matchmaking rule set.
tags Map<String,String>
ruleSetBody
This property is required.
Changes to this property will trigger replacement.
string
JSON encoded string containing rule set data.
name Changes to this property will trigger replacement. string
Name of the matchmaking rule set.
tags {[key: string]: string}
rule_set_body
This property is required.
Changes to this property will trigger replacement.
str
JSON encoded string containing rule set data.
name Changes to this property will trigger replacement. str
Name of the matchmaking rule set.
tags Mapping[str, str]
ruleSetBody
This property is required.
Changes to this property will trigger replacement.
String
JSON encoded string containing rule set data.
name Changes to this property will trigger replacement. String
Name of the matchmaking rule set.
tags Map<String>

Outputs

All input properties are implicitly available as output properties. Additionally, the MatchmakingRuleSet resource produces the following output properties:

Arn string
Rule Set ARN.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Rule Set ARN.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Rule Set ARN.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Rule Set ARN.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Rule Set ARN.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Rule Set ARN.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing MatchmakingRuleSet Resource

Get an existing MatchmakingRuleSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MatchmakingRuleSetState, opts?: CustomResourceOptions): MatchmakingRuleSet
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        name: Optional[str] = None,
        rule_set_body: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> MatchmakingRuleSet
func GetMatchmakingRuleSet(ctx *Context, name string, id IDInput, state *MatchmakingRuleSetState, opts ...ResourceOption) (*MatchmakingRuleSet, error)
public static MatchmakingRuleSet Get(string name, Input<string> id, MatchmakingRuleSetState? state, CustomResourceOptions? opts = null)
public static MatchmakingRuleSet get(String name, Output<String> id, MatchmakingRuleSetState state, CustomResourceOptions options)
resources:  _:    type: aws:gamelift:MatchmakingRuleSet    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
Rule Set ARN.
Name Changes to this property will trigger replacement. string
Name of the matchmaking rule set.
RuleSetBody Changes to this property will trigger replacement. string
JSON encoded string containing rule set data.
Tags Dictionary<string, string>
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Rule Set ARN.
Name Changes to this property will trigger replacement. string
Name of the matchmaking rule set.
RuleSetBody Changes to this property will trigger replacement. string
JSON encoded string containing rule set data.
Tags map[string]string
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Rule Set ARN.
name Changes to this property will trigger replacement. String
Name of the matchmaking rule set.
ruleSetBody Changes to this property will trigger replacement. String
JSON encoded string containing rule set data.
tags Map<String,String>
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Rule Set ARN.
name Changes to this property will trigger replacement. string
Name of the matchmaking rule set.
ruleSetBody Changes to this property will trigger replacement. string
JSON encoded string containing rule set data.
tags {[key: string]: string}
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Rule Set ARN.
name Changes to this property will trigger replacement. str
Name of the matchmaking rule set.
rule_set_body Changes to this property will trigger replacement. str
JSON encoded string containing rule set data.
tags Mapping[str, str]
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Rule Set ARN.
name Changes to this property will trigger replacement. String
Name of the matchmaking rule set.
ruleSetBody Changes to this property will trigger replacement. String
JSON encoded string containing rule set data.
tags Map<String>
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Import

GameLift Matchmaking Rule Sets can be imported using the ID, e.g.,

$ pulumi import aws:gamelift/matchmakingRuleSet:MatchmakingRuleSet example <ruleset-id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.