Struct aws_sdk_gamelift::client::fluent_builders::CreateScript [−][src]
pub struct CreateScript<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to CreateScript
.
Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:
-
A locally available directory. Use the ZipFile parameter for this option.
-
An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.
If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.
Learn more
Amazon GameLift Realtime Servers
Set Up a Role for Amazon GameLift Access
Related actions
CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task
Implementations
impl<C, M, R> CreateScript<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> CreateScript<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<CreateScriptOutput, SdkError<CreateScriptError>> where
R::Policy: SmithyRetryPolicy<CreateScriptInputOperationOutputAlias, CreateScriptOutput, CreateScriptError, CreateScriptInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<CreateScriptOutput, SdkError<CreateScriptError>> where
R::Policy: SmithyRetryPolicy<CreateScriptInputOperationOutputAlias, CreateScriptOutput, CreateScriptError, CreateScriptInputOperationRetryAlias>,
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.
A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.
A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.
Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.
Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.
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.
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.
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 AWS 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
.
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 AWS 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
.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for CreateScript<C, M, R>
impl<C, M, R> Unpin for CreateScript<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for CreateScript<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more