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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

Properties describing a Realtime script.

**Related actions**

All APIs by task][1

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets

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.

• #script_arn ⇒ String

  The Amazon Resource Name ([ARN]) that is assigned to a Amazon GameLift 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 'lib/aws-sdk-gamelift/types.rb', line 9969

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location)
  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 'lib/aws-sdk-gamelift/types.rb', line 9969

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

#script_arn ⇒ String

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html

Returns:

• (String)

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

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

#script_id ⇒ String

A unique identifier for the Realtime script

Returns:

• (String)

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

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location)
  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 'lib/aws-sdk-gamelift/types.rb', line 9969

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location)
  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 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)

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

class Script < Struct.new(
  :script_id,
  :script_arn,
  :name,
  :version,
  :size_on_disk,
  :creation_time,
  :storage_location)
  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 'lib/aws-sdk-gamelift/types.rb', line 9969

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