Experimental

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

Script L2 construct

A GameLift script, that is installed and runs on instances in an Amazon GameLift fleet.

It consists of a zip file with all of the components of the realtime game server script.

Stability: Experimental
CloudFormation: AWS::GameLift::Script
L1 type: CfnScript
Source: lib/script.ts

Example

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

python

# bucket: s3.Bucket

gamelift.Script(self, "Script",
    content=gamelift.Content.from_bucket(bucket, "sample-asset-key")
)

java

Bucket bucket;

Script.Builder.create(this, "Script")
        .content(Content.fromBucket(bucket, "sample-asset-key"))
        .build();

csharp

// Install: dotnet add package Amazon.CDK.AWS.GameLift.Alpha
Bucket bucket;

new Script(this, "Script", new ScriptProps {
    Content = Content.FromBucket(bucket, "sample-asset-key")
});

// Install: go get github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2
var bucket Bucket

gamelift.NewScript(this, jsii.String("Script"), &ScriptProps{
	Content: gamelift.Content_FromBucket(bucket, jsii.String("sample-asset-key")),
})

Initializer

new Script(scope: Construct, id: string, props: ScriptProps)

python

Script(scope: Construct, id: str, props: ScriptProps)

java

new Script(Construct scope, String id, ScriptProps props)

csharp

new Script(Construct scope, string id, ScriptProps props)

NewScript(Scope Construct, Id *string, Props ScriptProps)

Construct Props

contentContentcontentContentcontentContentContentContentContentContentrequired#

The game content.

roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#

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" }] }

scriptNameoptionalstringscript_nameoptionalstrscriptNameoptionalStringScriptNameoptionalstringScriptNameoptional*string#

Name of this realtime server script.

Default: No name

scriptVersionoptionalstringscript_versionoptionalstrscriptVersionoptionalStringScriptVersionoptionalstringScriptVersionoptional*string#

Version of this realtime server script.

Default: No version

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#

The principal this GameLift script is using.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole#

The IAM role GameLift assumes to acccess server script content.

scriptArnstringscript_arnstrscriptArnStringScriptArnstringScriptArn*string#

The ARN of the realtime server script.

scriptIdstringscript_idstrscriptIdStringScriptIdstringScriptId*string#

The Identifier of the realtime server script.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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

fromAsset(scope: Construct, id: string, path: string, options?: AssetOptions): Script // chainable

@staticmethod def from_asset(scope: Construct, id: str, path: str, options: typing.Optional[AssetOptions] = None) -> Script

public static Script fromAsset(Construct scope, String id, String path, AssetOptions options)public static Script FromAsset(Construct scope, string id, string path, AssetOptions? options = null)func FromAsset(Scope Construct, Id *string, Path *string, Options AssetOptions) Scriptstatic#

Create a new realtime server script from asset content.

fromBucket(scope: Construct, id: string, bucket: IBucket, key: string, objectVersion?: string): Script // chainable

@staticmethod def from_bucket(scope: Construct, id: str, bucket: IBucket, key: str, object_version: typing.Optional[str] = None) -> Script

public static Script fromBucket(Construct scope, String id, IBucket bucket, String key, String objectVersion)public static Script FromBucket(Construct scope, string id, IBucket bucket, string key, string? objectVersion = null)func FromBucket(Scope Construct, Id *string, Bucket IBucket, Key *string, ObjectVersion *string) Scriptstatic#

Create a new realtime server script from s3 content.

fromScriptArn(scope: Construct, id: string, scriptArn: string): IScript@staticmethod def from_script_arn(scope: Construct, id: str, script_arn: str) -> IScriptpublic static IScript fromScriptArn(Construct scope, String id, String scriptArn)public static IScript FromScriptArn(Construct scope, string id, string scriptArn)func FromScriptArn(Scope Construct, Id *string, ScriptArn *string) IScriptstatic#

Import a script into CDK using its ARN.

fromScriptAttributes(scope: Construct, id: string, attrs: ScriptAttributes): IScript@staticmethod def from_script_attributes(scope: Construct, id: str, attrs: ScriptAttributes) -> IScriptpublic static IScript fromScriptAttributes(Construct scope, String id, ScriptAttributes attrs)public static IScript FromScriptAttributes(Construct scope, string id, ScriptAttributes attrs)func FromScriptAttributes(Scope Construct, Id *string, Attrs ScriptAttributes) IScriptstatic#

Import an existing realtime server script from its attributes.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Script L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

Script L2 construct

Example

Initializer

Construct Props

Properties

Methods