Class CfnScript

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnScript
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnScript : CfnResource, IInspectable, IScriptRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnScript Inherits CfnResource Implements IInspectable, IScriptRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift;

             var cfnScript = new CfnScript(this, "MyCfnScript", new CfnScriptProps {
                 StorageLocation = new S3LocationProperty {
                     Bucket = "bucket",
                     Key = "key",
                     RoleArn = "roleArn",

                     // the properties below are optional
                     ObjectVersion = "objectVersion"
                 },

                 // the properties below are optional
                 Name = "name",
                 NodeJsVersion = "nodeJsVersion",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Version = "version"
             });

Synopsis

Constructors

CfnScript(Construct, string, ICfnScriptProps)

Create a new AWS::GameLift::Script.

Properties

AttrArn

The unique Amazon Resource Name (ARN) for the script.
AttrCreationTime

A time stamp indicating when this data object was created.
AttrId

A unique identifier for a Realtime script.
AttrSizeOnDisk

The file size of the uploaded Realtime script, expressed in bytes.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.
CfnPropertyNames

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.
Name

A descriptive label that is associated with a script.
NodeJsVersion

The Node.js version used for execution of the Realtime script.
ScriptRef

A reference to a Script resource.
StorageLocation

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

A list of labels to assign to the new script resource.
Version

The version that is associated with a build or script.

Methods

ArnForScript(IScriptRef)

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.
FromScriptArn(Construct, string, string)

Creates a new IScriptRef from an ARN.
FromScriptId(Construct, string, string)

Creates a new IScriptRef from a scriptId.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnScript(object)

Checks whether the given object is a CfnScript.
RenderProperties(IDictionary<string, object>)

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.

Constructors

CfnScript(Construct, string, ICfnScriptProps)

Create a new AWS::GameLift::Script.

public CfnScript(Construct scope, string id, ICfnScriptProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnScriptProps

Resource properties.

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

Properties

AttrArn

The unique Amazon Resource Name (ARN) for the script.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreationTime

A time stamp indicating when this data object was created.

public virtual string AttrCreationTime { get; }
Property Value

string

Remarks

Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

CloudformationAttribute: CreationTime

AttrId

A unique identifier for a Realtime script.

public virtual string AttrId { get; }
Property Value

string

Remarks

CloudformationAttribute: Id

AttrSizeOnDisk

The file size of the uploaded Realtime script, expressed in bytes.

public virtual double AttrSizeOnDisk { get; }
Property Value

double

Remarks

When files are uploaded from an S3 location, this value remains at "0".

CloudformationAttribute: SizeOnDisk

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

Name

A descriptive label that is associated with a script.

public virtual string? Name { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

NodeJsVersion

The Node.js version used for execution of the Realtime script.

public virtual string? NodeJsVersion { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

ScriptRef

A reference to a Script resource.

public virtual IScriptReference ScriptRef { get; }
Property Value

IScriptReference

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

StorageLocation

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.

public virtual object StorageLocation { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnScript.IS3LocationProperty

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

TagsRaw

A list of labels to assign to the new script resource.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

Version

The version that is associated with a build or script.

public virtual string? Version { get; set; }
Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

Methods

ArnForScript(IScriptRef)

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.

public static string ArnForScript(IScriptRef resource)
Parameters
resource IScriptRef
Returns

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift;

             var cfnScript = new CfnScript(this, "MyCfnScript", new CfnScriptProps {
                 StorageLocation = new S3LocationProperty {
                     Bucket = "bucket",
                     Key = "key",
                     RoleArn = "roleArn",

                     // the properties below are optional
                     ObjectVersion = "objectVersion"
                 },

                 // the properties below are optional
                 Name = "name",
                 NodeJsVersion = "nodeJsVersion",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Version = "version"
             });

FromScriptArn(Construct, string, string)

Creates a new IScriptRef from an ARN.

public static IScriptRef FromScriptArn(Construct scope, string id, string arn)
Parameters
scope Construct
id string
arn string
Returns

IScriptRef

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

FromScriptId(Construct, string, string)

Creates a new IScriptRef from a scriptId.

public static IScriptRef FromScriptId(Construct scope, string id, string scriptId)
Parameters
scope Construct
id string
scriptId string
Returns

IScriptRef

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

IsCfnScript(object)

Checks whether the given object is a CfnScript.

public static bool IsCfnScript(object x)
Parameters
x object
Returns

bool

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

CloudformationResource: AWS::GameLift::Script

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable