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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::GameLift::Script",
"Properties" : {
"Name" : String,
"StorageLocation" : S3Location,
"Tags" : [ Tag, ... ],
"Version" : String
}
}
YAML
Type: AWS::GameLift::Script
Properties:
Name: String
StorageLocation:
S3Location
Tags:
- Tag
Version: String
Properties
Name-
A descriptive label that is associated with a script. Script names do not need to be unique.
Required: No
Type: String
Minimum:
1Maximum:
1024Update requires: No interruption
StorageLocation-
The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers 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 Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the
ObjectVersionparameter to specify an earlier version.Required: Yes
Type: S3Location
Update requires: No interruption
-
A list of labels to assign to the new script resource. 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.
Required: No
Type: Array of Tag
Maximum:
200Update requires: No interruption
Version-
The version that is associated with a build or script. Version strings do not need to be unique.
Required: No
Type: String
Minimum:
1Maximum:
1024Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ScriptId, such as
script-1111aaaa-22bb-33cc-44dd-5555eeee66ff.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
Arn-
The unique Amazon Resource Name (ARN) for the script.
CreationTime-
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example
"1469498468.057"). Id-
A unique identifier for a Realtime script.
SizeOnDisk-
The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
Examples
Create a Realtime Servers Script
The following example creates a GameLift script named MyRealtimeScript.
The zipped script files are located in an S3 bucket, specified by the
S3Bucket and S3Key input parameters. The example also creates
the AWS Identity and Access Management role that GameLift assumes so that it has
permissions to download the script files.
JSON
{
"Resources": {
"IAMRole": {
"Type": "AWS::IAM::Role",
"Properties": {
"AssumeRolePolicyDocument": {
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": [
"cloudformation.amazonaws.com",
"gamelift.amazonaws.com"
]
},
"Action": "sts:AssumeRole"
}
]
},
"RoleName": "ScriptIAMRole",
"Policies": [
{
"PolicyName": "ScriptResourceIAMPolicy",
"PolicyDocument": {
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:GetObject",
"s3:GetObjectVersion",
"s3:GetObjectMetadata",
"s3:*Object*"
],
"Resource": [
"*"
]
}
]
}
}
]
}
},
"ScriptResource": {
"Type": "AWS::GameLift::Script",
"Properties": {
"Name": "MyRealtimeScript",
"Version": "v1.0",
"StorageLocation": {
"Bucket": "amzn-s3-demo-bucket",
"Key": "MyScriptFiles.zip",
"RoleArn": {
"Fn::GetAtt": [
"IAMRole",
"Arn"
]
}
}
}
}
}
}YAML
Resources:
IAMRole:
Type: AWS::IAM::Role
Properties:
AssumeRolePolicyDocument:
Version: "2012-10-17"
Statement:
- Effect: "Allow"
Principal:
Service: ["cloudformation.amazonaws.com", "gamelift.amazonaws.com"]
Action: "sts:AssumeRole"
RoleName: "ScriptIAMRole"
Policies:
- PolicyName: ScriptResourceIAMPolicy
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- "s3:GetObject"
- "s3:GetObjectVersion"
- "s3:GetObjectMetadata"
- "s3:*Object*"
Resource:
- "*"
ScriptResource:
Type: AWS::GameLift::Script
Properties:
Name: MyRealtimeScript
Version: v1.0
StorageLocation:
Bucket: "amzn-s3-demo-bucket"
Key: "MyScriptFiles.zip"
RoleArn: !GetAtt IAMRole.ArnSee also
-
Create GameLift resources using Amazon CloudFront in the Amazon GameLift Developer Guide
-
Upload script files in Amazon S3 in the Amazon GameLift Developer Guide
-
CreateScript in the Amazon GameLift API Reference
