Package software.amazon.awscdk.cfnpropertymixins.services.gamelift

Class CfnBuildPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.gamelift.CfnBuildPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnBuildPropsMixin>

Enclosing class:

CfnBuildPropsMixin

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

A fluent builder for CfnBuildPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnBuildPropsMixin	build()
static CfnBuildPropsMixin.Builder	create()
static CfnBuildPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnBuildPropsMixin.Builder	name(String name)	A descriptive label that is associated with a build.
CfnBuildPropsMixin.Builder	operatingSystem(String operatingSystem)	The operating system that your game server binaries run on.
CfnBuildPropsMixin.Builder	serverSdkVersion(String serverSdkVersion)	A server SDK version you used when integrating your game server build with Amazon GameLift Servers.
CfnBuildPropsMixin.Builder	storageLocation(CfnBuildPropsMixin.StorageLocationProperty storageLocation)	Information indicating where your game build files are stored.
CfnBuildPropsMixin.Builder	storageLocation(IResolvable storageLocation)	Information indicating where your game build files are stored.
CfnBuildPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnBuildPropsMixin.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 CfnBuildPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnBuildPropsMixin.Builder.

create

@Stability(Stable)
public static CfnBuildPropsMixin.Builder create()

Returns:

a new instance of CfnBuildPropsMixin.Builder.

name

@Stability(Stable)
public CfnBuildPropsMixin.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 CfnBuildPropsMixin.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 server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to 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 CfnBuildPropsMixin.Builder serverSdkVersion(String serverSdkVersion)

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

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

Parameters:

serverSdkVersion - A server SDK version you used when integrating your game server build with Amazon GameLift Servers. 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 CfnBuildPropsMixin.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 Servers 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 Servers 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 CfnBuildPropsMixin.Builder storageLocation(CfnBuildPropsMixin.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 Servers 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 Servers 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

tags

@Stability(Stable)
public CfnBuildPropsMixin.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

version

@Stability(Stable)
public CfnBuildPropsMixin.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 CfnBuildPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnBuildPropsMixin.