Package software.amazon.awscdk.services.gamelift

Class CfnBuild.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnBuild.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBuild>

Enclosing class:

CfnBuild

@Stability(Stable)
public static final class CfnBuild.Builder
extends Object
implements software.amazon.jsii.Builder<CfnBuild>

A fluent builder for CfnBuild.

Method Summary

Modifier and Type	Method	Description
CfnBuild	build()
static CfnBuild.Builder	create(software.constructs.Construct scope, String id)
CfnBuild.Builder	name(String name)	A descriptive label that is associated with a build.
CfnBuild.Builder	operatingSystem(String operatingSystem)	The operating system that your game server binaries run on.
CfnBuild.Builder	serverSdkVersion(String serverSdkVersion)	A server SDK version you used when integrating your game server build with Amazon GameLift.
CfnBuild.Builder	storageLocation(IResolvable storageLocation)	Information indicating where your game build files are stored.
CfnBuild.Builder	storageLocation(CfnBuild.StorageLocationProperty storageLocation)	Information indicating where your game build files are stored.
CfnBuild.Builder	version(String version)	Version information that is associated with this build.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnBuild.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnBuild.Builder.

name

@Stability(Stable)
public CfnBuild.Builder name(String name)

A descriptive label that is associated with a build.

Build names do not need to be unique.

Parameters:

name - A descriptive label that is associated with a build. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-name

operatingSystem

@Stability(Stable)
public CfnBuild.Builder operatingSystem(String operatingSystem)

The operating system that your game server binaries run on.

This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.

Parameters:

operatingSystem - The operating system that your game server binaries run on. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-operatingsystem

serverSdkVersion

@Stability(Stable)
public CfnBuild.Builder serverSdkVersion(String serverSdkVersion)

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

For more information see Integrate games with custom game servers . By default Amazon GameLift sets this value to 4.0.2 .

Parameters:

serverSdkVersion - A server SDK version you used when integrating your game server build with Amazon GameLift. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-serversdkversion

storageLocation

@Stability(Stable)
public CfnBuild.Builder storageLocation(IResolvable storageLocation)

Information indicating where your game build files are stored.

Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.

If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.

Parameters:

storageLocation - Information indicating where your game build files are stored. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation

storageLocation

@Stability(Stable)
public CfnBuild.Builder storageLocation(CfnBuild.StorageLocationProperty storageLocation)

Information indicating where your game build files are stored.

Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.

If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.

Parameters:

storageLocation - Information indicating where your game build files are stored. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-storagelocation

version

@Stability(Stable)
public CfnBuild.Builder version(String version)

Version information that is associated with this build.

Version strings do not need to be unique.

Parameters:

version - Version information that is associated with this build. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html#cfn-gamelift-build-version

build

@Stability(Stable)
public CfnBuild build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnBuild>

Returns:

a newly built instance of CfnBuild.