Interface UpdateScriptRequest.Builder

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

  • Method Details

    • scriptId

      UpdateScriptRequest.Builder scriptId(String scriptId)

      A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.

      Parameters:
      scriptId - A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

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

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

    • storageLocation

      UpdateScriptRequest.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 UpdateScriptRequest.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:

    • zipFile

      UpdateScriptRequest.Builder zipFile(SdkBytes zipFile)

      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 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: --zip-file fileb://myRealtimeScript.zip.

      Parameters:
      zipFile - 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 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: --zip-file fileb://myRealtimeScript.zip.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateScriptRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateScriptRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.