Amazon GameLift · JSON Structure

Gamelift Create Script Input Structure

CreateScriptInput schema from Amazon GameLift API

Type: object Properties: 5
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

CreateScriptInput is a JSON Structure definition published by Amazon GameLift, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Name Version StorageLocation ZipFile Tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-create-script-input-structure.json",
  "name": "CreateScriptInput",
  "description": "CreateScriptInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A descriptive label that is associated with a script. Script names don't need to be unique. You can use <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html\">UpdateScript</a> to change this value later. "
        }
      ]
    },
    "Version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "Version information associated with a build or script. Version strings don't need to be unique. You can use <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html\">UpdateScript</a> to change this value later. "
        }
      ]
    },
    "StorageLocation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Location"
        },
        {
          "description": "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 <code>ObjectVersion</code> parameter to specify an earlier version. "
        }
      ]
    },
    "ZipFile": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ZipBlob"
        },
        {
          "description": "<p>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.</p> <p>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: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>"
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "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 <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html\">TagResource</a>, <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html\">UntagResource</a>, and <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html\">ListTagsForResource</a> 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."
        }
      ]
    }
  }
}