Class: Aws::GameLift::Types::Script

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::Script

Defined in:

gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Properties describing a Realtime script.

Related actions

All APIs by task

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  A time stamp indicating when this data object was created.

• #name ⇒ String

  A descriptive label that is associated with a script.

• #node_js_version ⇒ String

  The Node.js version used for execution of your Realtime script.

• #script_arn ⇒ String

  The Amazon Resource Name ([ARN][1]) that is assigned to a Amazon GameLift Servers script resource and uniquely identifies it.

• #script_id ⇒ String

  A unique identifier for the Realtime script.

• #size_on_disk ⇒ Integer

  The file size of the uploaded Realtime script, expressed in bytes.

• #storage_location ⇒ Types::S3Location

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

• #version ⇒ String

  Version information that is associated with a build or script.

Instance Attribute Details

#creation_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 10803

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location,
  :node_js_version)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 10803

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location,
  :node_js_version)
  SENSITIVE = []
  include Aws::Structure
end

#node_js_version ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 10803

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location,
  :node_js_version)
  SENSITIVE = []
  include Aws::Structure
end

#script_arn ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 10803

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location,
  :node_js_version)
  SENSITIVE = []
  include Aws::Structure
end

#script_id ⇒ String

A unique identifier for the Realtime script

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 10803

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location,
  :node_js_version)
  SENSITIVE = []
  include Aws::Structure
end

#size_on_disk ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 10803

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location,
  :node_js_version)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Types::S3Location)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 10803

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location,
  :node_js_version)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 10803

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location,
  :node_js_version)
  SENSITIVE = []
  include Aws::Structure
end