@aws-cdk_aws-gamelift-alpha.ScriptBase

class ScriptBase ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.ScriptBase
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#ScriptBase
Javasoftware.amazon.awscdk.services.gamelift.alpha.ScriptBase
Pythonaws_cdk.aws_gamelift_alpha.ScriptBase
TypeScript (source)@aws-cdk/aws-gamelift-alpha ยป ScriptBase

Implements IConstruct, IDependable, IResource, IScript, IGrantable

Extends Resource

Implemented by Script

Base class for new and imported GameLift realtime server script.

Initializer

new ScriptBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

  • scope Construct
  • id string
  • props ResourceProps

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
grantPrincipal๐Ÿ”นIPrincipalThe principal to grant permissions to.
node๐Ÿ”นNodeThe tree node.
scriptArn๐Ÿ”นstringThe ARN of the realtime server script.
scriptId๐Ÿ”นstringThe Identifier of the realtime server script.
stack๐Ÿ”นStackThe stack in which this resource is defined.

env๐Ÿ”น

Type: ResourceEnvironment

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

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
toString()๐Ÿ”นReturns a string representation of this construct.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.