@aws-cdk/aws-gamelift-alpha.ScriptProps

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ScriptProps Struct

Properties for a new realtime server script.

ScriptProps

used as props by

• Script

Stability

Experimental

Source

lib/script.ts

Example

declare const bucket: s3.Bucket;
new gamelift.Script(this, 'Script', {
  content: gamelift.Content.fromBucket(bucket, "sample-asset-key")
});

Properties

contentContentcontentContentcontentContentContentContentContentContentrequired#

The game content.

role?optionalIRolerole?optionalIRolerole?optionalIRoleRole?optionalIRoleRole?optionalIRole#

The IAM role assumed by GameLift to access server script in S3.

Default: a role will be created with default permissions.

notes

If providing a custom role, it needs to trust the GameLift service principal (gamelift.amazonaws.com) and be granted sufficient permissions to have Read access to a specific key content into a specific S3 bucket. Below an example of required permission: { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion" ], "Resource": "arn:aws:s3:::bucket-name/object-name" }] }

scriptName?optionalstringscript_name?optionalstrscriptName?optionalStringScriptName?optionalstringScriptName?optional*string#

Name of this realtime server script.

Default: No name

scriptVersion?optionalstringscript_version?optionalstrscriptVersion?optionalStringScriptVersion?optionalstringScriptVersion?optional*string#

Version of this realtime server script.

Default: No version