Class CfnScript
The AWS::GameLift::Script
resource creates a new script record for your Realtime Servers script.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnScript : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnScript
Inherits CfnResource
Implements IInspectable, 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",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Version = "version"
});
Synopsis
Constructors
CfnScript(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnScript(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnScript(Construct, String, ICfnScriptProps) |
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 | |
Name | A descriptive label that is associated with a script. |
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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnScript(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnScript(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnScript(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnScript(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnScript(Construct, String, ICfnScriptProps)
public CfnScript(Construct scope, string id, ICfnScriptProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnScriptProps
Resource properties.
Properties
AttrArn
The unique Amazon Resource Name (ARN) for the script.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreationTime
A time stamp indicating when this data object was created.
public virtual string AttrCreationTime { get; }
Property Value
System.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
System.String
Remarks
CloudformationAttribute: Id
AttrSizeOnDisk
The file size of the uploaded Realtime script, expressed in bytes.
public virtual double AttrSizeOnDisk { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
A descriptive label that is associated with a script.
public virtual string Name { get; set; }
Property Value
System.String
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
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of labels to assign to the new script resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Version
The version that is associated with a build or script.
public virtual string Version { get; set; }
Property Value
System.String
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>