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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	A unique identifier for the Realtime script
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	scripts	INSERT	StorageLocation, region
delete_resource	scripts	DELETE	Identifier, region
update_resource	scripts	UPDATE	Identifier, PatchDocument, region
list_resources	scripts_list_only	SELECT	region
get_resource	scripts	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual script.

SELECT
  region,
  name,
  storage_location,
  version,
  tags,
  creation_time,
  arn,
  id,
  size_on_disk
FROM awscc.gamelift.scripts
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all scripts in a region.

SELECT
  region,
  id
FROM awscc.gamelift.scripts_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.gamelift.scripts (
  Name,
  StorageLocation,
  Version,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ storage_location }}',
  '{{ 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: script
  props:
    - name: name
      value: '{{ name }}'
    - name: storage_location
      value:
        bucket: '{{ bucket }}'
        key: '{{ key }}'
        object_version: '{{ object_version }}'
        role_arn: '{{ role_arn }}'
    - name: version
      value: '{{ version }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.gamelift.scripts
WHERE
  Identifier = '{{ 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 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