builds

Creates, updates, deletes or gets a build resource or lists builds in a region

Overview

Name	builds
Type	Resource
Description	Resource Type definition for AWS::GameLift::Build
Id	aws.gamelift.builds

Fields

Name	Datatype	Description
build_id	string	A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
name	string	A descriptive label that is associated with a build. Build names do not need to be unique.
operating_system	string	The 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. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
storage_location	object	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.
version	string	Version information that is associated with this build. Version strings do not need to be unique.
server_sdk_version	string	A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all builds in a region.

SELECT
region,
build_id,
name,
operating_system,
storage_location,
version,
server_sdk_version
FROM aws.gamelift.builds
WHERE region = 'us-east-1';

Gets all properties from an individual build.

SELECT
region,
build_id,
name,
operating_system,
storage_location,
version,
server_sdk_version
FROM aws.gamelift.builds
WHERE region = 'us-east-1' AND data__Identifier = '<BuildId>';

INSERT example

Use the following StackQL query and manifest file to create a new build resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.gamelift.builds (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.gamelift.builds (
 Name,
 OperatingSystem,
 StorageLocation,
 Version,
 ServerSdkVersion,
 region
)
SELECT 
 '{{ Name }}',
 '{{ OperatingSystem }}',
 '{{ StorageLocation }}',
 '{{ Version }}',
 '{{ ServerSdkVersion }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: build
    props:
      - name: Name
        value: '{{ Name }}'
      - name: OperatingSystem
        value: '{{ OperatingSystem }}'
      - name: StorageLocation
        value:
          Bucket: '{{ Bucket }}'
          Key: '{{ Key }}'
          ObjectVersion: '{{ ObjectVersion }}'
          RoleArn: '{{ RoleArn }}'
      - name: Version
        value: '{{ Version }}'
      - name: ServerSdkVersion
        value: '{{ ServerSdkVersion }}'

DELETE example

/*+ delete */
DELETE FROM aws.gamelift.builds
WHERE data__Identifier = '<BuildId>'
AND region = 'us-east-1';

Permissions

To operate on the builds resource, the following permissions are required:

Create

gamelift:DescribeBuild,
gamelift:CreateBuild

Read

gamelift:DescribeBuild

Update

gamelift:UpdateBuild

Delete

gamelift:DescribeBuild,
gamelift:DeleteBuild

List

gamelift:ListBuilds