createScript method

Future<CreateScriptOutput> createScript({ String? name, S3Location? storageLocation, List<Tag>? tags, String? version, Uint8List? zipFile, })

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 AWS 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 operations

• CreateScript
• ListScripts
• DescribeScript
• UpdateScript
• DeleteScript

May throw UnauthorizedException. May throw InvalidRequestException. May throw ConflictException. May throw TaggingFailedException. May throw InternalServiceException.

Parameter name : A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Parameter storageLocation : The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region where you are creating 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. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Parameter tags : A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS 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 AWS General Reference for actual tagging limits.

Parameter version : The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Parameter 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 AWS 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: --zip-file fileb://myRealtimeScript.zip.

Implementation

Future<CreateScriptOutput> createScript({
  String? name,
  S3Location? storageLocation,
  List<Tag>? tags,
  String? version,
  Uint8List? zipFile,
}) async {
  _s.validateStringLength(
    'name',
    name,
    1,
    1024,
  );
  _s.validateStringLength(
    'version',
    version,
    1,
    1024,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.CreateScript'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (name != null) 'Name': name,
      if (storageLocation != null) 'StorageLocation': storageLocation,
      if (tags != null) 'Tags': tags,
      if (version != null) 'Version': version,
      if (zipFile != null) 'ZipFile': base64Encode(zipFile),
    },
  );

  return CreateScriptOutput.fromJson(jsonResponse.body);
}