Struct aws_sdk_gamelift::client::fluent_builders::UpdateScript

pub struct UpdateScript { /* private fields */ }

Fluent builder constructing a request to UpdateScript.

Updates Realtime script metadata and content.

To update script metadata, specify the script ID and provide updated name and/or version values.

To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.

If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.

Learn more

Amazon GameLift Realtime Servers

Related actions

CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task

Implementations

impl UpdateScript

pub async fn send(
    self
) -> Result<UpdateScriptOutput, SdkError<UpdateScriptError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn script_id(self, input: impl Into<String>) -> Self

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

pub fn set_script_id(self, input: Option<String>) -> Self

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

pub fn name(self, input: impl Into<String>) -> Self

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

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn version(self, input: impl Into<String>) -> Self

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

pub fn set_version(self, input: Option<String>) -> Self

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

pub fn storage_location(self, input: S3Location) -> Self

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.

pub fn set_storage_location(self, input: Option<S3Location>) -> Self

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.

pub fn zip_file(self, input: Blob) -> Self

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.

pub fn set_zip_file(self, input: Option<Blob>) -> Self

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.

Trait Implementations

impl Clone for UpdateScript

fn clone(&self) -> UpdateScript

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateScript

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.