Class CfnScript
A CloudFormation AWS::GameLift::Script
.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.AWS.GameLift.dll
Syntax (csharp)
public class CfnScript : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnScript
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::GameLift::Script
resource creates a new script record for your Realtime Servers script. 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.
CloudformationResource: AWS::GameLift::Script
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html
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(Construct, String, ICfnScriptProps) | Create a new |
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 |
Properties
AttrArn | The unique Amazon Resource Name (ARN) for the script. |
AttrId | A unique identifier for a Realtime script. |
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 | 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(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 System.String
- scoped id of the resource.
- props ICfnScriptProps
- resource properties.
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
Properties
AttrArn
The unique Amazon Resource Name (ARN) for the script.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
A unique identifier for a Realtime script.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
Remarks
Script names do not need to be unique.
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
Remarks
The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion
parameter to specify an earlier version.
Tags
A list of labels to assign to the new script resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
Version
The version that is associated with a build or script.
public virtual string Version { get; set; }
Property Value
System.String
Remarks
Version strings do not need to be unique.
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>