Class CfnBuildProps

Properties for defining a CfnBuild.

Inheritance

object

CfnBuildProps

Implements

ICfnBuildProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnBuildProps : ICfnBuildProps

Syntax (vb)

Public Class CfnBuildProps Implements ICfnBuildProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift;

             var cfnBuildProps = new CfnBuildProps {
                 Name = "name",
                 OperatingSystem = "operatingSystem",
                 ServerSdkVersion = "serverSdkVersion",
                 StorageLocation = new StorageLocationProperty {
                     Bucket = "bucket",
                     Key = "key",
                     RoleArn = "roleArn",

                     // the properties below are optional
                     ObjectVersion = "objectVersion"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Version = "version"
             };

Synopsis

Constructors

CfnBuildProps()

Properties for defining a CfnBuild.

Properties

Name	A descriptive label that is associated with a build.
OperatingSystem	The operating system that your game server binaries run on.
ServerSdkVersion	A server SDK version you used when integrating your game server build with Amazon GameLift Servers.
StorageLocation	Information indicating where your game build files are stored.
Tags	An array of key-value pairs to apply to this resource.
Version	Version information that is associated with this build.

Constructors

CfnBuildProps()

Properties for defining a CfnBuild.

public CfnBuildProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift;

             var cfnBuildProps = new CfnBuildProps {
                 Name = "name",
                 OperatingSystem = "operatingSystem",
                 ServerSdkVersion = "serverSdkVersion",
                 StorageLocation = new StorageLocationProperty {
                     Bucket = "bucket",
                     Key = "key",
                     RoleArn = "roleArn",

                     // the properties below are optional
                     ObjectVersion = "objectVersion"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Version = "version"
             };

Properties

Name

A descriptive label that is associated with a build.

public string? Name { get; set; }

Property Value

string

Remarks

Build names do not need to be unique.

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

OperatingSystem

The operating system that your game server binaries run on.

public string? OperatingSystem { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/amazon-linux-2/faqs/">Amazon Linux 2 FAQs</a> . 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 <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html">Migrate to server SDK version 5.</a>

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

ServerSdkVersion

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

public string? ServerSdkVersion { get; set; }

Property Value

string

Remarks

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

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

StorageLocation

Information indicating where your game build files are stored.

public object? StorageLocation { get; set; }

Property Value

object

Remarks

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.

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

Tags

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

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

Version

Version information that is associated with this build.

public string? Version { get; set; }

Property Value

string

Remarks

Version strings do not need to be unique.

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

Implements

ICfnBuildProps