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

CreateBuild

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.

Important

When setting up a new game build for Amazon GameLift, we recommend using the AWS 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 AWS 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

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 associated with a build. Build names don't 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 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.

Note

If you have active fleets using the Windows Server 2012 operating system, you can continue to create new builds using this OS until October 10, 2023, when Microsoft ends its support. All others must use Windows Server 2016 when creating new Windows-based builds.

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 associated with a build or script. Version strings don't 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": "MegaFrogRaceServer_NA_build_files",
        "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": "MegaFrogRaceServer_NA_build_files", 
        "Key": "MegaFrogRaceServer_build_123.zip"
    } 
}

Create a game build resource for manually uploading files to Amazon GameLift

This example creates a new build resource. It also gets a storage location and temporary credentials that allow you to manually upload your game build to the Amazon GameLift location in Amazon S3. 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_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_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=="
    }
}