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	awscc.gamelift.builds

Fields

get (all properties)

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.
▶tags	array	An array of key-value pairs to apply to this resource.
build_arn	string	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift build ARN, the resource ID matches the BuildId value.
region	string	AWS region.

list (identifiers only)

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.
region	string	AWS region.

For more information, see AWS::GameLift::Build.

Methods

Name	Resource	Accessible by	Required Params
create_resource	builds	INSERT	, region
delete_resource	builds	DELETE	Identifier, region
update_resource	builds	UPDATE	Identifier, PatchDocument, region
list_resources	builds_list_only	SELECT	region
get_resource	builds	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual build.

SELECT
  region,
  build_id,
  name,
  operating_system,
  storage_location,
  version,
  server_sdk_version,
  tags,
  build_arn
FROM awscc.gamelift.builds
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ build_id }}';

list (identifiers only)

Lists all builds in a region.

SELECT
  region,
  build_id
FROM awscc.gamelift.builds_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.gamelift.builds (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.gamelift.builds (
  Name,
  OperatingSystem,
  StorageLocation,
  Version,
  ServerSdkVersion,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ operating_system }}',
  '{{ storage_location }}',
  '{{ version }}',
  '{{ server_sdk_version }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: operating_system
      value: '{{ operating_system }}'
    - name: storage_location
      value:
        bucket: '{{ bucket }}'
        key: '{{ key }}'
        object_version: '{{ object_version }}'
        role_arn: '{{ role_arn }}'
    - name: version
      value: '{{ version }}'
    - name: server_sdk_version
      value: '{{ server_sdk_version }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.gamelift.builds
SET PatchDocument = string('{{ {
    "Name": name,
    "Version": version,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ build_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.gamelift.builds
WHERE
  Identifier = '{{ build_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

gamelift:DescribeBuild,
gamelift:CreateBuild,
gamelift:ListTagsForResource,
gamelift:TagResource,
iam:PassRole

Read

gamelift:DescribeBuild,
gamelift:ListTagsForResource

Update

gamelift:UpdateBuild,
gamelift:DescribeBuild,
gamelift:TagResource,
gamelift:UntagResource,
gamelift:ListTagsForResource

Delete

gamelift:DescribeBuild,
gamelift:DeleteBuild

List

gamelift:ListBuilds