Package software.amazon.awscdk.services.gamelift.alpha

Interface ScriptProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ScriptProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:15.724Z") @Stability(Experimental) public interface ScriptProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for a new realtime server script.

Example: 

 Bucket bucket;
 Script.Builder.create(this, "Script")
         .content(Content.fromBucket(bucket, "sample-asset-key"))
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    ScriptProps.Builder
    A builder for ScriptProps
    static final class 
    ScriptProps.Jsii$Proxy
    An implementation for ScriptProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static ScriptProps.Builder
    builder()
     
    Content
    getContent()
    (experimental) The game content.
    default IRole
    getRole()
    (experimental) The IAM role assumed by GameLift to access server script in S3.
    default String
    getScriptName()
    (experimental) Name of this realtime server script.
    default String
    getScriptVersion()
    (experimental) Version of this realtime server script.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getContent

      @Stability(Experimental) @NotNull Content getContent()
      (experimental) The game content.

    • getRole

      @Stability(Experimental) @Nullable default IRole getRole()
      (experimental) The IAM role assumed by GameLift to access server script in S3.

      If providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com) and be granted sufficient permissions to have Read access to a specific key content into a specific S3 bucket. Below an example of required permission: { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion" ], "Resource": "arn:aws:s3:::bucket-name/object-name" }] }

      Default: - a role will be created with default permissions.

      See Also:

    • getScriptName

      @Stability(Experimental) @Nullable default String getScriptName()
      (experimental) Name of this realtime server script.

      Default: No name

    • getScriptVersion

      @Stability(Experimental) @Nullable default String getScriptVersion()
      (experimental) Version of this realtime server script.

      Default: No version

    • builder

      @Stability(Experimental) static ScriptProps.Builder builder()
      Returns:
      a ScriptProps.Builder of ScriptProps