Class Script

(experimental) A GameLift script, that is installed and runs on instances in an Amazon GameLift fleet.

Inheritance

object

Resource

ScriptBase

Script

Implements

IScript

IResource

IConstruct

IDependable

IEnvironmentAware

IGrantable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyCrossStackReferenceStrength(ReferenceStrength)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.With(params IMixin[])

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.GameLift.Alpha

Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll

Syntax (csharp)

public class Script : ScriptBase, IScript, IResource, IConstruct, IDependable, IEnvironmentAware, IGrantable

Syntax (vb)

Public Class Script Inherits ScriptBase Implements IScript, IResource, IConstruct, IDependable, IEnvironmentAware, IGrantable

Remarks

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

Stability: Experimental

See: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-script-uploading.html

Resource: AWS::GameLift::Script

ExampleMetadata: infused

Examples

Bucket bucket;

             new Script(this, "Script", new ScriptProps {
                 Content = Content.FromBucket(bucket, "sample-asset-key")
             });

Synopsis

Constructors

Script(Construct, string, IScriptProps)

(experimental) A GameLift script, that is installed and runs on instances in an Amazon GameLift fleet.

Properties

GrantPrincipal	(experimental) The principal this GameLift script is using.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.
Role	(experimental) The IAM role GameLift assumes to acccess server script content.
ScriptArn	(experimental) The ARN of the realtime server script.
ScriptId	(experimental) The Identifier of the realtime server script.

Methods

FromAsset(Construct, string, string, IAssetOptions?)	(experimental) Create a new realtime server script from asset content.
FromBucket(Construct, string, IBucket, string, string?)	(experimental) Create a new realtime server script from s3 content.
FromScriptArn(Construct, string, string)	(experimental) Import a script into CDK using its ARN.
FromScriptAttributes(Construct, string, IScriptAttributes)	(experimental) Import an existing realtime server script from its attributes.

Constructors

Script(Construct, string, IScriptProps)

(experimental) A GameLift script, that is installed and runs on instances in an Amazon GameLift fleet.

public Script(Construct scope, string id, IScriptProps props)

Parameters

scope Construct

id string

props IScriptProps

Remarks

Stability: Experimental

Properties

GrantPrincipal

(experimental) The principal this GameLift script is using.

public override IPrincipal GrantPrincipal { get; }

Property Value

IPrincipal

Overrides

ScriptBase.GrantPrincipal

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

Role

(experimental) The IAM role GameLift assumes to acccess server script content.

public virtual IRole Role { get; }

Property Value

IRole

Remarks

Stability: Experimental

ScriptArn

(experimental) The ARN of the realtime server script.

public override string ScriptArn { get; }

Property Value

string

Overrides

ScriptBase.ScriptArn

Remarks

Stability: Experimental

ScriptId

(experimental) The Identifier of the realtime server script.

public override string ScriptId { get; }

Property Value

string

Overrides

ScriptBase.ScriptId

Remarks

Stability: Experimental

Methods

FromAsset(Construct, string, string, IAssetOptions?)

(experimental) Create a new realtime server script from asset content.

public static Script FromAsset(Construct scope, string id, string path, IAssetOptions? options = null)

Parameters

scope Construct

id string

path string

options IAssetOptions

Returns

Script

Remarks

Stability: Experimental

FromBucket(Construct, string, IBucket, string, string?)

(experimental) Create a new realtime server script from s3 content.

public static Script FromBucket(Construct scope, string id, IBucket bucket, string key, string? objectVersion = null)

Parameters

scope Construct

id string

bucket IBucket

key string

objectVersion string

Returns

Script

Remarks

Stability: Experimental

FromScriptArn(Construct, string, string)

(experimental) Import a script into CDK using its ARN.

public static IScript FromScriptArn(Construct scope, string id, string scriptArn)

Parameters

scope Construct

id string

scriptArn string

Returns

IScript

Remarks

Stability: Experimental

FromScriptAttributes(Construct, string, IScriptAttributes)

(experimental) Import an existing realtime server script from its attributes.

public static IScript FromScriptAttributes(Construct scope, string id, IScriptAttributes attrs)

Parameters

scope Construct

id string

attrs IScriptAttributes

Returns

IScript

Remarks

Stability: Experimental

Implements

IScript

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

IGrantable