Module Values.ScriptSource

Properties describing a Realtime script. Related actions All APIs by task

Sourcetype nonrec t = {
  1. scriptId : ScriptId.t option;
    (*

    A unique identifier for the Realtime script

    *)
  2. scriptArn : ScriptArn.t option;
    (*

    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.

    *)
  3. name : NonZeroAndMaxString.t option;
    (*

    A descriptive label that is associated with a script. Script names do not need to be unique.

    *)
  4. version : NonZeroAndMaxString.t option;
    (*

    Version information that is associated with a build or script. Version strings do not need to be unique.

    *)
  5. sizeOnDisk : WholeNumberLong.t option;
    (*

    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".

    *)
  6. creationTime : Timestamp.t option;
    (*

    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

    *)
  7. storageLocation : S3Location.t option;
    (*

    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 Servers 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 Servers 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.

    *)
  8. nodeJsVersion : NodeJsVersion.t option;
    (*

    The Node.js version used for execution of your Realtime script. The valid values are 10.x | 24.x. By default, NodeJsVersion is 10.x. This value cannot be updated later. Node.js 10 will reach end of support on September 30, 2026. See more details in the Node.js 10 FAQs. For migration guidance, see Migrating from Node.js 10 to 24.

    *)
}
Sourceval make : ?scriptId:??? -> ?scriptArn:??? -> ?name:??? -> ?version:??? -> ?sizeOnDisk:??? -> ?creationTime:??? -> ?storageLocation:??? -> ?nodeJsVersion:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Long of WholeNumberLong.t | `String of ScriptId.t | `Structure of (string * [> `String of NonEmptyString.t ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t