LocationModel
Properties of a location, which can include its name, ARN (for custom locations), and ping beacon information.
Contents
Note
In the following list, the required parameters are described first.
- LocationArn
-
The Amazon Resource Name (ARN) that is assigned to a custom location resource and uniquely identifies it. ARNs are unique across all Regions. Format is
arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^arn:.*:location\/custom-\S+Required: No
- LocationName
-
The location's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[A-Za-z0-9\-]+Required: No
- PingBeacon
-
Information about the UDP ping beacon for this location. Ping beacons are fixed endpoints that you can use to measure network latency between a player device and an Amazon GameLift Servers hosting location.
Type: PingBeacon object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
