Container for the parameters to the CreateScript operation. 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.
To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:
-
A locally available directory. Use the ZipFile parameter for this option.
-
An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.
If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.
Learn more
Amazon GameLift Realtime Servers
Set Up a Role for Amazon GameLift Access
Related actions
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.CreateScriptRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class CreateScriptRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The CreateScriptRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateScriptRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Name | System.String |
Gets and sets the property Name. A descriptive label that is associated with a script. Script names don't need to be unique. You can use UpdateScript to change this value later. |
|
|
StorageLocation | Amazon.GameLift.Model.S3Location |
Gets and sets the property StorageLocation.
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 |
|
|
Tags | System.Collections.Generic.List<Amazon.GameLift.Model.Tag> |
Gets and sets the property Tags. A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services 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 Amazon Web Services General Reference for actual tagging limits. |
|
|
Version | System.String |
Gets and sets the property Version. Version information associated with a build or script. Version strings don't need to be unique. You can use UpdateScript to change this value later. |
|
|
ZipFile | System.IO.MemoryStream |
Gets and sets the property ZipFile. A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.
When using the Amazon Web Services CLI tool to create a script, this parameter is
set to the zip file name. It must be prepended with the string "fileb://" to indicate
that the file data is a binary object. For example: |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5