Class Script
(experimental) A GameLift script, that is installed and runs on instances in an Amazon GameLift fleet.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift.Alpha
Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll
Syntax (csharp)
public class Script : ScriptBase, IScript, IResource, IGrantable
Syntax (vb)
Public Class Script
Inherits ScriptBase
Implements IScript, IResource, 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Script(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Script(Construct, String, IScriptProps) |
Properties
GrantPrincipal | (experimental) The principal this GameLift script is using. |
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(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Script(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Script(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Script(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Script(Construct, String, IScriptProps)
public Script(Construct scope, string id, IScriptProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IScriptProps
Remarks
Stability: Experimental
Properties
GrantPrincipal
(experimental) The principal this GameLift script is using.
public override IPrincipal GrantPrincipal { get; }
Property Value
Overrides
Remarks
Stability: Experimental
Role
(experimental) The IAM role GameLift assumes to acccess server script content.
public virtual IRole Role { get; }
Property Value
Remarks
Stability: Experimental
ScriptArn
(experimental) The ARN of the realtime server script.
public override string ScriptArn { get; }
Property Value
System.String
Overrides
Remarks
Stability: Experimental
ScriptId
(experimental) The Identifier of the realtime server script.
public override string ScriptId { get; }
Property Value
System.String
Overrides
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 Constructs.Construct
- id System.String
- path System.String
- options IAssetOptions
Returns
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 Constructs.Construct
- id System.String
- bucket IBucket
- key System.String
- objectVersion System.String
Returns
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 Constructs.Construct
- id System.String
- scriptArn System.String
Returns
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 Constructs.Construct
- id System.String
- attrs IScriptAttributes
Returns
Remarks
Stability: Experimental