Build - Amazon GameLift
ContentsSee Also

Build

Properties describing a custom game build.

All APIs by task

Contents

Note

In the following list, the required parameters are described first.

BuildArn

The Amazon Resource Name (ARN) assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

Type: String

Pattern: ^arn:.*:build\/build-\S+

Required: No

BuildId

A unique identifier for the build.

Type: String

Pattern: ^build-\S+

Required: No

CreationTime

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

Type: Timestamp

Required: No

Name

A descriptive label associated with a build. Build names don't need to be unique. It can be set using CreateBuild or UpdateBuild.

Type: String

Required: No

OperatingSystem

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

Type: String

Valid Values: WINDOWS_2012 | AMAZON_LINUX | AMAZON_LINUX_2 | WINDOWS_2016 | AMAZON_LINUX_2023

Required: No

ServerSdkVersion

The Amazon GameLift Server SDK version used to develop your game server.

Type: String

Length Constraints: Maximum length of 128.

Pattern: ^\d+\.\d+\.\d+$

Required: No

SizeOnDisk

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED or when using a custom Amazon S3 storage location, this value is 0.

Type: Long

Valid Range: Minimum value of 1.

Required: No

Status

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED -- The game build upload failed. You cannot create new fleets for this build.

Type: String

Valid Values: INITIALIZED | READY | FAILED

Required: No

Version

Version information associated with a build or script. Version strings don't need to be unique.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: