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

Class Script

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.gamelift.alpha.ScriptBase
software.amazon.awscdk.services.gamelift.alpha.Script
All Implemented Interfaces:
IResource, IScript, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:50.037Z") @Stability(Experimental) public class Script extends ScriptBase
(experimental) A GameLift script, that is installed and runs on instances in an Amazon GameLift fleet.

It consists of a zip file with all of the components of the realtime game server script.

Example: 

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

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Script.Builder
    (experimental) A fluent builder for Script.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IScript

    IScript.Jsii$Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROPERTY_INJECTION_ID
    (experimental) Uniquely identifies this class.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Script(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Script(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    Script(software.constructs.Construct scope, String id, ScriptProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Script
    fromAsset(software.constructs.Construct scope, String id, String path)
    (experimental) Create a new realtime server script from asset content.
    static Script
    fromAsset(software.constructs.Construct scope, String id, String path, AssetOptions options)
    (experimental) Create a new realtime server script from asset content.
    static Script
    fromBucket(software.constructs.Construct scope, String id, IBucket bucket, String key)
    (experimental) Create a new realtime server script from s3 content.
    static Script
    fromBucket(software.constructs.Construct scope, String id, IBucket bucket, String key, String objectVersion)
    (experimental) Create a new realtime server script from s3 content.
    static IScript
    fromScriptArn(software.constructs.Construct scope, String id, String scriptArn)
    (experimental) Import a script into CDK using its ARN.
    static IScript
    fromScriptAttributes(software.constructs.Construct scope, String id, ScriptAttributes attrs)
    (experimental) Import an existing realtime server script from its attributes.
    IPrincipal
    getGrantPrincipal()
    (experimental) The principal this GameLift script is using.
    IRole
    getRole()
    (experimental) The IAM role GameLift assumes to acccess server script content.
    String
    getScriptArn()
    (experimental) The ARN of the realtime server script.
    String
    getScriptId()
    (experimental) The Identifier of the realtime server script.

    Methods inherited from class software.amazon.awscdk.Resource

    applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • Script

      protected Script(software.amazon.jsii.JsiiObjectRef objRef)

    • Script

      protected Script(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Script

      @Stability(Experimental) public Script(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ScriptProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromAsset

      @Stability(Experimental) @NotNull public static Script fromAsset(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String path, @Nullable AssetOptions options)
      (experimental) Create a new realtime server script from asset content.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      path - This parameter is required.
      options -

    • fromAsset

      @Stability(Experimental) @NotNull public static Script fromAsset(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String path)
      (experimental) Create a new realtime server script from asset content.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      path - This parameter is required.

    • fromBucket

      @Stability(Experimental) @NotNull public static Script fromBucket(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull IBucket bucket, @NotNull String key, @Nullable String objectVersion)
      (experimental) Create a new realtime server script from s3 content.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      bucket - This parameter is required.
      key - This parameter is required.
      objectVersion -

    • fromBucket

      @Stability(Experimental) @NotNull public static Script fromBucket(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull IBucket bucket, @NotNull String key)
      (experimental) Create a new realtime server script from s3 content.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      bucket - This parameter is required.
      key - This parameter is required.

    • fromScriptArn

      @Stability(Experimental) @NotNull public static IScript fromScriptArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String scriptArn)
      (experimental) Import a script into CDK using its ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      scriptArn - This parameter is required.

    • fromScriptAttributes

      @Stability(Experimental) @NotNull public static IScript fromScriptAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ScriptAttributes attrs)
      (experimental) Import an existing realtime server script from its attributes.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • getGrantPrincipal

      @Stability(Experimental) @NotNull public IPrincipal getGrantPrincipal()
      (experimental) The principal this GameLift script is using.
      Specified by:
      getGrantPrincipal in interface IGrantable
      Specified by:
      getGrantPrincipal in class ScriptBase

    • getRole

      @Stability(Experimental) @NotNull public IRole getRole()
      (experimental) The IAM role GameLift assumes to acccess server script content.

    • getScriptArn

      @Stability(Experimental) @NotNull public String getScriptArn()
      (experimental) The ARN of the realtime server script.
      Specified by:
      getScriptArn in interface IScript
      Specified by:
      getScriptArn in class ScriptBase

    • getScriptId

      @Stability(Experimental) @NotNull public String getScriptId()
      (experimental) The Identifier of the realtime server script.
      Specified by:
      getScriptId in interface IScript
      Specified by:
      getScriptId in class ScriptBase