Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateBuild

Creates an Amazon GameLift build resource for your game server software and stores the software for deployment to hosting resources. Combine game server binaries and dependencies into a single .zip file

Important

Use the AWS CLI command upload-build to quickly and simply create a new build and upload your game build .zip file to Amazon GameLift Amazon S3. This helper command eliminates the need to explicitly manage access permissions.

Alternatively, use the CreateBuild action for the following scenarios:

You want to create a build and upload a game build zip file from in an Amazon S3 location that you control. In this scenario, you need to give Amazon GameLift permission to access to the Amazon S3 bucket. With permission in place, call CreateBuild and specify a build name, the build's runtime operating system, and the Amazon S3 storage location where the build file is stored.
You want to create a build and upload a local game build zip file to an Amazon S3 location that's controlled by Amazon GameLift. (See the upload-build CLI command for this scenario.) In this scenario, you need to request temporary access credentials to the Amazon GameLift Amazon S3 location. Specify a build name and the build's runtime operating system. The response provides an Amazon S3 location and a set of temporary access credentials. Use the credentials to upload your build files to the specified Amazon S3 location (see Uploading Objects in the Amazon S3 Developer Guide). You can't update build files after uploading them to Amazon GameLift Amazon S3.

If successful, this action creates a new build resource with a unique build ID and places it in INITIALIZED status. When the build reaches READY status, you can create fleets with it.

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

All APIs by task

Request Syntax


{
   "Name": "string",
   "OperatingSystem": "string",
   "ServerSdkVersion": "string",
   "StorageLocation": { 
      "Bucket": "string",
      "Key": "string",
      "ObjectVersion": "string",
      "RoleArn": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Version": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

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

Name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

OperatingSystem

The environment 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. This parameter is required, and there's no default value. You can't change a build's operating system later.

Note

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.

Type: String

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

Required: No

ServerSdkVersion

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.

Type: String

Length Constraints: Maximum length of 128.

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

Required: No

StorageLocation

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.

Type: S3Location object

Required: No

Tags

A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS 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 AWS General Reference for actual tagging limits.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Version

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax


{
   "Build": { 
      "BuildArn": "string",
      "BuildId": "string",
      "CreationTime": number,
      "Name": "string",
      "OperatingSystem": "string",
      "ServerSdkVersion": "string",
      "SizeOnDisk": number,
      "Status": "string",
      "Version": "string"
   },
   "StorageLocation": { 
      "Bucket": "string",
      "Key": "string",
      "ObjectVersion": "string",
      "RoleArn": "string"
   },
   "UploadCredentials": { 
      "AccessKeyId": "string",
      "SecretAccessKey": "string",
      "SessionToken": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Build

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

Type: Build object

StorageLocation

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

Type: S3Location object

UploadCredentials

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.

Type: AwsCredentials object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

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.

HTTP Status Code: 400

InternalServiceException

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

TaggingFailedException

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.

HTTP Status Code: 400

UnauthorizedException

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

HTTP Status Code: 400

Examples

Create a build with files in your own S3 bucket

This example creates a custom game build resource. It uses zipped files that are stored in an S3 location in an AWS account that you control. This example assumes that you've already created an IAM role that gives Amazon GameLift permission to access the S3 location. The request must specify a valid operating system value.

Sample Request


{
    "Name": "MegaFrogRaceServer.NA",
    "Version": "12345.678",
    "OperatingSystem": "WINDOWS_2016", 
    "StorageLocation": {
        "Bucket": "amzn-s3-demo-source-bucket1",
        "Key": "MegaFrogRaceServer_build_123.zip",
        "RoleArn": "arn:aws:iam::111122223333:role/GameLiftAccess"
    } 
}

Sample Response


{
    "Build": {
        "BuildArn": "arn:aws:gamelift:us-west-2::build/build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "CreationTime": 1496708916.18, 
        "Name": "MegaFrogRaceServer.NA", 
        "OperatingSystem": "WINDOWS_2016", 
        "SizeOnDisk": 0, 
        "Status": "READY", 
        "Version": "12345.678"
    }, 
    "StorageLocation": {
        "Bucket": "amzn-s3-demo-source-bucket1", 
        "Key": "MegaFrogRaceServer_build_123.zip"
    } 
}

Create a game build resource and manually upload files to Amazon GameLift

This example creates a new build resource and returns an Amazon S3 storage location and temporary credentials. Use this information to manually upload your game build. When you specify a storage location, Amazon GameLift reports the SizeOnDisk as 0. You can find the actual size in Amazon S3. After you upload your build, Amazon GameLift validates the build and updates the new build's status. The request must specify a valid operating system value.

Sample Request


{
    "Name": "MegaFrogRaceServer.NA",
    "Version": "12345.678",
    "OperatingSystem": "AMAZON_LINUX_2023"
    "OperatingSystem": "AMAZON_LINUX_2"
}

Sample Response


{
    "Build": {
        "BuildArn": "arn:aws:gamelift:us-west-2::build/build-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
        "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", 
        "CreationTime": 1496708916.18, 
        "Name": "MegaFrogRaceServer.NA", 
    "OperatingSystem": "AMAZON_LINUX_2023",
    "OperatingSystem": "AMAZON_LINUX_2",
        "SizeOnDisk": 0, 
        "Status": "READY", 
        "Version": "12345.678"
    }, 
    "StorageLocation": {
        "Bucket": "gamelift-builds-us-west-2",
        "Key": "123456789012/build-1111aaaa-22bb-33cc-44dd-5555eeee66ff"
    }, 
    "UploadCredentials": {
        "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", 
        "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", 
        "SessionToken": "AgoGb3JpZ2luENz...EXAMPLETOKEN=="
    }
}