Class: Aws::GameLift::Types::Build

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-gamelift/types.rb

Overview

Properties describing a custom game build.

All APIs by task][1

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#build_arn ⇒ String

The Amazon Resource Name ([ARN]) that is assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is ‘arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`. In a GameLift build ARN, the resource ID matches the BuildId value.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end

#build_id ⇒ String

A unique identifier for the build.

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example ‘“1469498468.057”`).

Returns:

  • (Time) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using [CreateBuild] or [UpdateBuild].

[1]: docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html [2]: docs.aws.amazon.com/gamelift/latest/apireference/UpdateBuild

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end

#operating_system ⇒ String

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

<note markdown=“1”> 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.]

</note>

[1]: aws.amazon.com/amazon-linux-2/faqs/ [2]: docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end

#server_sdk_version ⇒ String

The Amazon GameLift Server SDK version used to develop your game server.

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end

#size_on_disk ⇒ Integer

File size of the uploaded game build, expressed in bytes. When the build status is ‘INITIALIZED` or when using a custom Amazon S3 storage location, this value is 0.

Returns:

  • (Integer) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

Version information that is associated with a build or script. Version strings do not need to be unique.

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aws-sdk-gamelift/types.rb', line 304

class Build < Struct.new(
  :build_id,
  :build_arn,
  :name,
  :version,
  :status,
  :size_on_disk,
  :operating_system,
  :creation_time,
  :server_sdk_version)
  SENSITIVE = []
  include Aws::Structure
end