Interface Script.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Script.Builder,Script>, SdkBuilder<Script.Builder,Script>, SdkPojo
Enclosing class:
Script
@Mutable @NotThreadSafe public static interface Script.Builder extends SdkPojo, CopyableBuilder<Script.Builder,Script>

  • Method Details

    • scriptId

      Script.Builder scriptId(String scriptId)

      A unique identifier for the Realtime script

      Parameters:
      scriptId - A unique identifier for the Realtime script
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scriptArn

      Script.Builder scriptArn(String scriptArn)

      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.

      Parameters:
      scriptArn - 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:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Script.Builder name(String name)

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

      Parameters:
      name - A descriptive label that is associated with a script. Script names do not need to be unique.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      Script.Builder version(String version)

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

      Parameters:
      version - Version information that is associated with a build or script. Version strings do not need to be unique.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sizeOnDisk

      Script.Builder sizeOnDisk(Long sizeOnDisk)

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

      Parameters:
      sizeOnDisk - 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:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      Script.Builder creationTime(Instant creationTime)

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

      Parameters:
      creationTime - 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:
      Returns a reference to this object so that method calls can be chained together.

    • storageLocation

      Script.Builder storageLocation(S3Location storageLocation)

      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.

      Parameters:
      storageLocation - 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:
      Returns a reference to this object so that method calls can be chained together.

    • storageLocation

      default Script.Builder storageLocation(Consumer<S3Location.Builder> storageLocation)

      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.

      This is a convenience method that creates an instance of the S3Location.Builder avoiding the need to create one manually via S3Location.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageLocation(S3Location).

      Parameters:
      storageLocation - a consumer that will call methods on S3Location.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nodeJsVersion

      Script.Builder nodeJsVersion(String nodeJsVersion)

      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.

      Parameters:
      nodeJsVersion - 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:
      Returns a reference to this object so that method calls can be chained together.