@aws-cdk/aws-gamelift-alpha.IMatchmakingConfiguration

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IMatchmakingConfiguration Interface

Represents a Gamelift matchmaking configuration.

IMatchmakingConfiguration

extends

• IResource

implemented by

• MatchmakingConfigurationBase,
• QueuedMatchmakingConfiguration,
• 1 more

  • StandaloneMatchmakingConfiguration

Stability

Experimental

Source

lib/matchmaking-configuration.ts

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

matchmakingConfigurationArnstringmatchmaking_configuration_arnstrmatchmakingConfigurationArnStringMatchmakingConfigurationArnstringMatchmakingConfigurationArn*string#

The ARN of the matchmaking configuration.

matchmakingConfigurationNamestringmatchmaking_configuration_namestrmatchmakingConfigurationNameStringMatchmakingConfigurationNamestringMatchmakingConfigurationName*string#

The name of the matchmaking configuration.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

notificationTarget?may be undefinedITopicnotification_target?may be undefinedITopicnotificationTarget?may be undefinedITopicNotificationTarget?may be undefinedITopicNotificationTarget?may be undefinedITopic#

The notification target for matchmaking events.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#

Return the given named metric for this matchmaking configuration.

metricCurrentTickets(props?: MetricOptions): Metricdef metric_current_tickets(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricCurrentTickets(MetricOptions props)public Metric MetricCurrentTickets(MetricOptions? props = null)func MetricCurrentTickets(Props MetricOptions) Metric#

Matchmaking requests currently being processed or waiting to be processed.

metricMatchesAccepted(props?: MetricOptions): Metricdef metric_matches_accepted(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMatchesAccepted(MetricOptions props)public Metric MetricMatchesAccepted(MetricOptions? props = null)func MetricMatchesAccepted(Props MetricOptions) Metric#

For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.

metricMatchesCreated(props?: MetricOptions): Metricdef metric_matches_created(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMatchesCreated(MetricOptions props)public Metric MetricMatchesCreated(MetricOptions? props = null)func MetricMatchesCreated(Props MetricOptions) Metric#

Potential matches that were created since the last report.

metricMatchesPlaced(props?: MetricOptions): Metricdef metric_matches_placed(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMatchesPlaced(MetricOptions props)public Metric MetricMatchesPlaced(MetricOptions? props = null)func MetricMatchesPlaced(Props MetricOptions) Metric#

Matches that were successfully placed into a game session since the last report.

metricMatchesRejected(props?: MetricOptions): Metricdef metric_matches_rejected(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMatchesRejected(MetricOptions props)public Metric MetricMatchesRejected(MetricOptions? props = null)func MetricMatchesRejected(Props MetricOptions) Metric#

For matchmaking configurations that require acceptance, the potential matches that were rejected by at least one player since the last report.

metricPlayersStarted(props?: MetricOptions): Metricdef metric_players_started(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricPlayersStarted(MetricOptions props)public Metric MetricPlayersStarted(MetricOptions? props = null)func MetricPlayersStarted(Props MetricOptions) Metric#

Players in matchmaking tickets that were added since the last report.

metricTimeToMatch(props?: MetricOptions): Metricdef metric_time_to_match(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricTimeToMatch(MetricOptions props)public Metric MetricTimeToMatch(MetricOptions? props = null)func MetricTimeToMatch(Props MetricOptions) Metric#

For matchmaking requests that were put into a potential match before the last report, the amount of time between ticket creation and potential match creation.

Units: seconds

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining