aws-cdk-lib.aws_gamelift.CfnBuildProps

interface CfnBuildProps

LanguageType name
.NETAmazon.CDK.AWS.GameLift.CfnBuildProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnBuildProps
Javasoftware.amazon.awscdk.services.gamelift.CfnBuildProps
Pythonaws_cdk.aws_gamelift.CfnBuildProps
TypeScript aws-cdk-lib » aws_gamelift » CfnBuildProps

Properties for defining a CfnBuild.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnBuildProps: gamelift.CfnBuildProps = {
  name: 'name',
  operatingSystem: 'operatingSystem',
  serverSdkVersion: 'serverSdkVersion',
  storageLocation: {
    bucket: 'bucket',
    key: 'key',
    roleArn: 'roleArn',

    // the properties below are optional
    objectVersion: 'objectVersion',
  },
  version: 'version',
};

Properties

NameTypeDescription
name?stringA descriptive label that is associated with a build.
operatingSystem?stringThe operating system that your game server binaries run on.
serverSdkVersion?stringA server SDK version you used when integrating your game server build with Amazon GameLift.
storageLocation?IResolvable | StorageLocationPropertyInformation indicating where your game build files are stored.
version?stringVersion information that is associated with this build.

name?

Type: string (optional)

A descriptive label that is associated with a build.

Build names do not need to be unique.


operatingSystem?

Type: string (optional)

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.

The Amazon Linux 2023 OS is not available in the China Regions. > Support is ending in 2023 for the Windows Server 2012 and Amazon Linux (AL1) operating systems. If you have active fleets using these operating systems, you can continue to create new builds using these until their end of support. All other users must use Windows Server 2016, Amazon Linux 2, or Amazon Linux 2023. For more information, including specific end-of-support dates, see the Amazon GameLift FAQs for Windows Server and Linux Server .


serverSdkVersion?

Type: string (optional)

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 .


storageLocation?

Type: IResolvable | StorageLocationProperty (optional)

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.


version?

Type: string (optional)

Version information that is associated with this build.

Version strings do not need to be unique.