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

Interface BuildProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BuildProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:53.224Z")
@Stability(Experimental)
public interface BuildProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a new 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BuildProps.Builder	A builder for BuildProps
static final class	BuildProps.Jsii$Proxy	An implementation for BuildProps

Method Summary

Modifier and Type	Method	Description
static BuildProps.Builder	builder()
default String	getBuildName()	(experimental) Name of this build.
default String	getBuildVersion()	(experimental) Version of this build.
Content	getContent()	(experimental) The game build file storage.
default OperatingSystem	getOperatingSystem()	(experimental) The operating system that the game server binaries are built to run on.
default IRole	getRole()	(experimental) The IAM role assumed by GameLift to access server build in S3.
default String	getServerSdkVersion()	(experimental) A server SDK version you used when integrating your game server build with Amazon GameLift.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContent

@Stability(Experimental)
@NotNull
Content getContent()

(experimental) The game build file storage.

getBuildName

@Stability(Experimental)
@Nullable
default String getBuildName()

(experimental) Name of this build.

Default: No name

getBuildVersion

@Stability(Experimental)
@Nullable
default String getBuildVersion()

(experimental) Version of this build.

Default: No version

getOperatingSystem

@Stability(Experimental)
@Nullable
default OperatingSystem getOperatingSystem()

(experimental) The operating system that the game server binaries are built to run on.

Default: No version

getRole

@Stability(Experimental)
@Nullable
default IRole getRole()

(experimental) The IAM role assumed by GameLift to access server build in S3.

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

Default: - a role will be created with default permissions.

See Also:

• https://docs.aws.amazon.com/gamelift/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-access-storage-loc

getServerSdkVersion

@Stability(Experimental)
@Nullable
default String getServerSdkVersion()

(experimental) A server SDK version you used when integrating your game server build with Amazon GameLift.

Default: - 4.0.2

See Also:

• https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html

builder

@Stability(Experimental)
static BuildProps.Builder builder()

Returns:

a BuildProps.Builder of BuildProps