AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

MatchmakingConfiguration

import "github.com/aws/aws-sdk-go/service/gamelift"

type MatchmakingConfiguration struct { AcceptanceRequired *bool `type:"boolean"` AcceptanceTimeoutSeconds *int64 `min:"1" type:"integer"` AdditionalPlayerCount *int64 `type:"integer"` CreationTime *time.Time `type:"timestamp"` CustomEventData *string `type:"string"` Description *string `min:"1" type:"string"` GameProperties []*GameProperty `type:"list"` GameSessionData *string `min:"1" type:"string"` GameSessionQueueArns []*string `type:"list"` Name *string `min:"1" type:"string"` NotificationTarget *string `type:"string"` RequestTimeoutSeconds *int64 `min:"1" type:"integer"` RuleSetName *string `min:"1" type:"string"` }

Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.

AcceptanceRequired

Type: *bool

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

AcceptanceTimeoutSeconds

Type: *int64

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

AdditionalPlayerCount

Type: *int64

Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

CreationTime

Type: *time.Time

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

CustomEventData

Type: *string

Information to attached to all events related to the matchmaking configuration.

Description

Type: *string

Descriptive label that is associated with matchmaking configuration.

GameProperties

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create).

GameSessionData

Type: *string

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)). This information is added to the new GameSession object that is created for a successful match.

GameSessionQueueArns

Type: []*string

Amazon Resource Name (ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Name

Type: *string

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

NotificationTarget

Type: *string

SNS topic ARN that is set up to receive matchmaking notifications.

RequestTimeoutSeconds

Type: *int64

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

RuleSetName

Type: *string

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

Method

GoString

func (s MatchmakingConfiguration) GoString() string

GoString returns the string representation

SetAcceptanceRequired

func (s *MatchmakingConfiguration) SetAcceptanceRequired(v bool) *MatchmakingConfiguration

SetAcceptanceRequired sets the AcceptanceRequired field's value.

SetAcceptanceTimeoutSeconds

func (s *MatchmakingConfiguration) SetAcceptanceTimeoutSeconds(v int64) *MatchmakingConfiguration

SetAcceptanceTimeoutSeconds sets the AcceptanceTimeoutSeconds field's value.

SetAdditionalPlayerCount

func (s *MatchmakingConfiguration) SetAdditionalPlayerCount(v int64) *MatchmakingConfiguration

SetAdditionalPlayerCount sets the AdditionalPlayerCount field's value.

SetCreationTime

func (s *MatchmakingConfiguration) SetCreationTime(v time.Time) *MatchmakingConfiguration

SetCreationTime sets the CreationTime field's value.

SetCustomEventData

func (s *MatchmakingConfiguration) SetCustomEventData(v string) *MatchmakingConfiguration

SetCustomEventData sets the CustomEventData field's value.

SetDescription

func (s *MatchmakingConfiguration) SetDescription(v string) *MatchmakingConfiguration

SetDescription sets the Description field's value.

SetGameProperties

func (s *MatchmakingConfiguration) SetGameProperties(v []*GameProperty) *MatchmakingConfiguration

SetGameProperties sets the GameProperties field's value.

SetGameSessionData

func (s *MatchmakingConfiguration) SetGameSessionData(v string) *MatchmakingConfiguration

SetGameSessionData sets the GameSessionData field's value.

SetGameSessionQueueArns

func (s *MatchmakingConfiguration) SetGameSessionQueueArns(v []*string) *MatchmakingConfiguration

SetGameSessionQueueArns sets the GameSessionQueueArns field's value.

SetName

func (s *MatchmakingConfiguration) SetName(v string) *MatchmakingConfiguration

SetName sets the Name field's value.

SetNotificationTarget

func (s *MatchmakingConfiguration) SetNotificationTarget(v string) *MatchmakingConfiguration

SetNotificationTarget sets the NotificationTarget field's value.

SetRequestTimeoutSeconds

func (s *MatchmakingConfiguration) SetRequestTimeoutSeconds(v int64) *MatchmakingConfiguration

SetRequestTimeoutSeconds sets the RequestTimeoutSeconds field's value.

SetRuleSetName

func (s *MatchmakingConfiguration) SetRuleSetName(v string) *MatchmakingConfiguration

SetRuleSetName sets the RuleSetName field's value.

String

func (s MatchmakingConfiguration) String() string

String returns the string representation

On this page: