Package software.amazon.awscdk.services.gamelift.alpha

Class Build

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.gamelift.alpha.BuildBase

software.amazon.awscdk.services.gamelift.alpha.Build

All Implemented Interfaces:

IEnvironmentAware, IResource, IBuild, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:49.769Z")
@Stability(Experimental)
public class Build
extends BuildBase

(experimental) A GameLift build, 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 game server build.

Example:

 Bucket bucket;
 Build build = Build.Builder.create(this, "Build")
         .content(Content.fromBucket(bucket, "sample-asset-key"))
         .build();
 CfnOutput.Builder.create(this, "BuildArn").value(build.getBuildArn()).build();
 CfnOutput.Builder.create(this, "BuildId").value(build.getBuildId()).build();
 

See Also:

• https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Build.Builder	(experimental) A fluent builder for Build.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IBuild

IBuild.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Build(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Build(software.amazon.jsii.JsiiObjectRef objRef)
	Build(software.constructs.Construct scope, String id, BuildProps props)

Method Summary

Modifier and Type	Method	Description
static Build	fromAsset(software.constructs.Construct scope, String id, String path)	(experimental) Create a new Build from asset content.
static Build	fromAsset(software.constructs.Construct scope, String id, String path, AssetOptions options)	(experimental) Create a new Build from asset content.
static Build	fromBucket(software.constructs.Construct scope, String id, IBucket bucket, String key)	(experimental) Create a new Build from s3 content.
static Build	fromBucket(software.constructs.Construct scope, String id, IBucket bucket, String key, String objectVersion)	(experimental) Create a new Build from s3 content.
static IBuild	fromBuildArn(software.constructs.Construct scope, String id, String buildArn)	(experimental) Import a build into CDK using its ARN.
static IBuild	fromBuildAttributes(software.constructs.Construct scope, String id, BuildAttributes attrs)	(experimental) Import an existing build from its attributes.
static IBuild	fromBuildId(software.constructs.Construct scope, String id, String buildId)	(experimental) Import a build into CDK using its identifier.
String	getBuildArn()	(experimental) The ARN of the build.
String	getBuildId()	(experimental) The Identifier of the build.
IPrincipal	getGrantPrincipal()	(experimental) The principal this GameLift Build is using.
IRole	getRole()	(experimental) The IAM role GameLift assumes to acccess server build content.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Experimental)
public static final String PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

Constructor Details

Build

protected Build(software.amazon.jsii.JsiiObjectRef objRef)

Build

protected Build(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Build

@Stability(Experimental)
public Build(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BuildProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromAsset

@Stability(Experimental)
@NotNull
public static Build fromAsset(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String path,
 @Nullable
 AssetOptions options)

(experimental) Create a new Build from asset content.

Parameters:

scope - This parameter is required.

id - This parameter is required.

path - This parameter is required.

options -

fromAsset

@Stability(Experimental)
@NotNull
public static Build fromAsset(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String path)

(experimental) Create a new Build from asset content.

Parameters:

scope - This parameter is required.

id - This parameter is required.

path - This parameter is required.

fromBucket

@Stability(Experimental)
@NotNull
public static Build fromBucket(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 IBucket bucket,
 @NotNull
 String key,
 @Nullable
 String objectVersion)

(experimental) Create a new Build from s3 content.

Parameters:

scope - This parameter is required.

id - This parameter is required.

bucket - This parameter is required.

key - This parameter is required.

objectVersion -

fromBucket

@Stability(Experimental)
@NotNull
public static Build fromBucket(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 IBucket bucket,
 @NotNull
 String key)

(experimental) Create a new Build from s3 content.

Parameters:

scope - This parameter is required.

id - This parameter is required.

bucket - This parameter is required.

key - This parameter is required.

fromBuildArn

@Stability(Experimental)
@NotNull
public static IBuild fromBuildArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String buildArn)

(experimental) Import a build into CDK using its ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

buildArn - This parameter is required.

fromBuildAttributes

@Stability(Experimental)
@NotNull
public static IBuild fromBuildAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 BuildAttributes attrs)

(experimental) Import an existing build from its attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

fromBuildId

@Stability(Experimental)
@NotNull
public static IBuild fromBuildId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String buildId)

(experimental) Import a build into CDK using its identifier.

Parameters:

scope - This parameter is required.

id - This parameter is required.

buildId - This parameter is required.

getBuildArn

@Stability(Experimental)
@NotNull
public String getBuildArn()

(experimental) The ARN of the build.

Specified by:

getBuildArn in interface IBuild

Specified by:

getBuildArn in class BuildBase

getBuildId

@Stability(Experimental)
@NotNull
public String getBuildId()

(experimental) The Identifier of the build.

Specified by:

getBuildId in interface IBuild

Specified by:

getBuildId in class BuildBase

getGrantPrincipal

@Stability(Experimental)
@NotNull
public IPrincipal getGrantPrincipal()

(experimental) The principal this GameLift Build is using.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in class BuildBase

getRole

@Stability(Experimental)
@NotNull
public IRole getRole()

(experimental) The IAM role GameLift assumes to acccess server build content.