You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::CreateScriptInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateScriptInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "NonZeroAndMaxString",
  version: "NonZeroAndMaxString",
  storage_location: {
    bucket: "NonEmptyString",
    key: "NonEmptyString",
    role_arn: "NonEmptyString",
    object_version: "NonEmptyString",
  },
  zip_file: "data",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

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.

Returns:

  • (String) —

    A descriptive label that is associated with a script.

#storage_location ⇒ Types::S3Location

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.

Returns:

  • (Types::S3Location) —

    The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.

#tags ⇒ Array<Types::Tag>

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.

Returns:

  • (Array<Types::Tag>) —

    A list of labels to assign to the new script resource.

#version ⇒ String

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.

Returns:

  • (String) —

    The version that is associated with a build or script.

#zip_file ⇒ String

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.

Returns:

  • (String) —

    A data object containing your Realtime scripts and dependencies as a zip file.