scripts

Creates, updates, deletes or gets a script resource or lists scripts in a region

Overview

Name	scripts
Type	Resource
Description	The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
Id	aws.gamelift.scripts

Fields

Name	Datatype	Description
name	string	A descriptive label that is associated with a script. Script names do not need to be unique.
storage_location	object	The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
version	string	The version that is associated with a script. Version strings do not need to be unique.
tags	array	An array of key-value pairs to apply to this resource.
creation_time	string	A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
arn	string	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
id	string	A unique identifier for the Realtime script
size_on_disk	integer	The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	StorageLocation, 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 scripts in a region.

SELECT
region,
name,
storage_location,
version,
tags,
creation_time,
arn,
id,
size_on_disk
FROM aws.gamelift.scripts
WHERE region = 'us-east-1';

Gets all properties from an individual script.

SELECT
region,
name,
storage_location,
version,
tags,
creation_time,
arn,
id,
size_on_disk
FROM aws.gamelift.scripts
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Create

gamelift:CreateScript,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:DescribeScript,
iam:PassRole

Read

gamelift:DescribeScript,
gamelift:ListScripts,
gamelift:ListTagsForResource

Delete

gamelift:DeleteScript

List

gamelift:ListScripts,
gamelift:DescribeScript

Update

gamelift:DescribeScript,
gamelift:UpdateScript,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:UntagResource,
iam:PassRole