CreateBuildCommand

Suggest an Edit

Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift.

When setting up a new game build for Amazon GameLift, we recommend using the CLI command upload-build  . This helper command combines two tasks: (1) it uploads your build files from a file directory to an Amazon GameLift Amazon S3 location, and (2) it creates a new build resource.

You can use the CreateBuild operation in the following scenarios:

  • Create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build.

  • Upload your build files to a Amazon GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects  in the Amazon S3 Developer Guide. After you upload build files to the Amazon GameLift Amazon S3 location, you can't update them.

If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.

Learn more

Uploading Your Game 

Create a Build with Files in Amazon S3 

All APIs by task 

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GameLiftClient, CreateBuildCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
// const { GameLiftClient, CreateBuildCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
const client = new GameLiftClient(config);
const input = { // CreateBuildInput
  Name: "STRING_VALUE",
  Version: "STRING_VALUE",
  StorageLocation: { // S3Location
    Bucket: "STRING_VALUE",
    Key: "STRING_VALUE",
    RoleArn: "STRING_VALUE",
    ObjectVersion: "STRING_VALUE",
  },
  OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023",
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  ServerSdkVersion: "STRING_VALUE",
};
const command = new CreateBuildCommand(input);
const response = await client.send(command);
// { // CreateBuildOutput
//   Build: { // Build
//     BuildId: "STRING_VALUE",
//     BuildArn: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Version: "STRING_VALUE",
//     Status: "INITIALIZED" || "READY" || "FAILED",
//     SizeOnDisk: Number("long"),
//     OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023",
//     CreationTime: new Date("TIMESTAMP"),
//     ServerSdkVersion: "STRING_VALUE",
//   },
//   UploadCredentials: { // AwsCredentials
//     AccessKeyId: "STRING_VALUE",
//     SecretAccessKey: "STRING_VALUE",
//     SessionToken: "STRING_VALUE",
//   },
//   StorageLocation: { // S3Location
//     Bucket: "STRING_VALUE",
//     Key: "STRING_VALUE",
//     RoleArn: "STRING_VALUE",
//     ObjectVersion: "STRING_VALUE",
//   },
// };

CreateBuildCommand Input

See CreateBuildCommandInput for more details

Parameter
Type
Description
Name
string | undefined

A descriptive label that is associated with a build. Build names do not need to be unique. You can change this value later.

OperatingSystem
OperatingSystem | undefined

The operating system that your game server binaries run on. This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5. 

ServerSdkVersion
string | undefined

A server SDK version you used when integrating your game server build with Amazon GameLift. For more information see Integrate games with custom game servers . By default Amazon GameLift sets this value to 4.0.2.

StorageLocation
S3Location | undefined

Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.

If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.

Tags
Tag[] | undefined

A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources  in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource , UntagResource , and ListTagsForResource  to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.

Version
string | undefined

Version information that is associated with a build or script. Version strings do not need to be unique. You can change this value later.

CreateBuildCommand Output

See CreateBuildCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Build
Build | undefined

The newly created build resource, including a unique build IDs and status.

StorageLocation
S3Location | undefined

Amazon S3 location for your game build file, including bucket name and key.

UploadCredentials
AwsCredentials | undefined

This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials .

Throws

Name
Fault
Details
ConflictException
client

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

InternalServiceException
server

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException
client

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

TaggingFailedException
client

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.

UnauthorizedException
client

The client failed authentication. Clients should not retry such requests.

GameLiftServiceException
Base exception class for all service exceptions from GameLift service.