Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.Types.Build

Description

Synopsis

data Build = Build' {
- buildArn :: Maybe Text
- buildId :: Maybe Text
- creationTime :: Maybe POSIX
- name :: Maybe Text
- operatingSystem :: Maybe OperatingSystem
- serverSdkVersion :: Maybe Text
- sizeOnDisk :: Maybe Natural
- status :: Maybe BuildStatus
- version :: Maybe Text
}
newBuild :: Build
build_buildArn :: Lens' Build (Maybe Text)
build_buildId :: Lens' Build (Maybe Text)
build_creationTime :: Lens' Build (Maybe UTCTime)
build_name :: Lens' Build (Maybe Text)
build_operatingSystem :: Lens' Build (Maybe OperatingSystem)
build_serverSdkVersion :: Lens' Build (Maybe Text)
build_sizeOnDisk :: Lens' Build (Maybe Natural)
build_status :: Lens' Build (Maybe BuildStatus)
build_version :: Lens' Build (Maybe Text)

Documentation

data Build Source #

Properties describing a custom game build.

All APIs by task

See: newBuild smart constructor.

Constructors

Build'

Fields

buildArn :: Maybe Text
The Amazon Resource Name (ARN) assigned to a 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.
buildId :: Maybe Text
A unique identifier for the build.
creationTime :: Maybe POSIX
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
name :: Maybe Text
A descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.
operatingSystem :: Maybe OperatingSystem
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.
serverSdkVersion :: Maybe Text
The GameLift Server SDK version used to develop your game server.
sizeOnDisk :: Maybe Natural
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.
status :: Maybe BuildStatus
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.
version :: Maybe Text
Version information associated with a build or script. Version strings do not need to be unique.

Instances

Instances details

FromJSON Build Source #
Instance details Defined in Amazonka.GameLift.Types.Build Methods parseJSON :: Value -> Parser Build # parseJSONList :: Value -> Parser [Build] #
Generic Build Source #
Instance details Defined in Amazonka.GameLift.Types.Build Associated Types type Rep Build :: Type -> Type # Methods from :: Build -> Rep Build x # to :: Rep Build x -> Build #
Read Build Source #
Instance details Defined in Amazonka.GameLift.Types.Build Methods readsPrec :: Int -> ReadS Build # readList :: ReadS [Build] # readPrec :: ReadPrec Build # readListPrec :: ReadPrec [Build] #
Show Build Source #
Instance details Defined in Amazonka.GameLift.Types.Build Methods showsPrec :: Int -> Build -> ShowS # show :: Build -> String # showList :: [Build] -> ShowS #
NFData Build Source #
Instance details Defined in Amazonka.GameLift.Types.Build Methods rnf :: Build -> () #
Eq Build Source #
Instance details Defined in Amazonka.GameLift.Types.Build Methods (==) :: Build -> Build -> Bool # (/=) :: Build -> Build -> Bool #
Hashable Build Source #
Instance details Defined in Amazonka.GameLift.Types.Build Methods hashWithSalt :: Int -> Build -> Int # hash :: Build -> Int #
type Rep Build Source #
Instance details Defined in Amazonka.GameLift.Types.Build type Rep Build = D1 ('MetaData "Build" "Amazonka.GameLift.Types.Build" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "Build'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "buildArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "buildId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "operatingSystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OperatingSystem)) :: S1 ('MetaSel ('Just "serverSdkVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sizeOnDisk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BuildStatus)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newBuild :: Build Source #

Create a value of Build with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:buildArn:Build', build_buildArn - The Amazon Resource Name (ARN) assigned to a 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.

$sel:buildId:Build', build_buildId - A unique identifier for the build.

$sel:creationTime:Build', build_creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

$sel:name:Build', build_name - A descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

$sel:operatingSystem:Build', build_operatingSystem - 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.

$sel:serverSdkVersion:Build', build_serverSdkVersion - The GameLift Server SDK version used to develop your game server.

$sel:sizeOnDisk:Build', build_sizeOnDisk - 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.

$sel:status:Build', build_status - 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.

$sel:version:Build', build_version - Version information associated with a build or script. Version strings do not need to be unique.

build_buildArn :: Lens' Build (Maybe Text) Source #

The Amazon Resource Name (ARN) assigned to a 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.

build_buildId :: Lens' Build (Maybe Text) Source #

A unique identifier for the build.

build_creationTime :: Lens' Build (Maybe UTCTime) Source #

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

build_name :: Lens' Build (Maybe Text) Source #

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

build_operatingSystem :: Lens' Build (Maybe OperatingSystem) Source #

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.

build_serverSdkVersion :: Lens' Build (Maybe Text) Source #

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

build_sizeOnDisk :: Lens' Build (Maybe Natural) Source #

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.

build_status :: Lens' Build (Maybe BuildStatus) Source #

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.

build_version :: Lens' Build (Maybe Text) Source #

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