interface IScript
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.GameLift.Alpha.IScript |
Go | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#IScript |
Java | software.amazon.awscdk.services.gamelift.alpha.IScript |
Python | aws_cdk.aws_gamelift_alpha.IScript |
TypeScript (source) | @aws-cdk/aws-gamelift-alpha ยป IScript |
Implemented by
Script
Obtainable from
Script
.fromScriptArn()
, Script
.fromScriptAttributes()
Your configuration and custom game logic for use with Realtime Servers.
Realtime Servers are provided by GameLift to use instead of a custom-built game server. You configure Realtime Servers for your game clients by creating a script using JavaScript, and add custom game logic as appropriate to host game sessions for your players. You upload the Realtime script to the GameLift service in the Regions where you plan to set up fleets.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
grant | IPrincipal | The principal to grant permissions to. |
node | Node | The tree node. |
script | string | The ARN of the realtime server script. |
script | string | The Identifier of the realtime server script. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
grantPrincipal
Type:
IPrincipal
The principal to grant permissions to.
node
Type:
Node
The tree node.
scriptArn
Type:
string
The ARN of the realtime server script.
scriptId
Type:
string
The Identifier of the realtime server script.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).