Network.AWS.GameLift.CreateBuild

Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.

Game server binaries must be combined into a .zip file for use with Amazon GameLift. See Uploading Your Game for more information.

Important: To create new builds quickly and easily, use the AWS CLI command upload-build . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions. See Upload Build Files to Amazon GameLift for more help.

The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios:

• Store a build file in an Amazon S3 bucket under your own AWS account. To use this option, you must first give Amazon GameLift access to that Amazon S3 bucket. See Create a Build with Files in Amazon S3 for detailed help. To create a new build record using files in your Amazon S3 bucket, call CreateBuild and specify a build name, operating system, and the storage location of your game build.
• Upload a build file directly to Amazon GameLift's Amazon S3 account. To use this option, you first call CreateBuild with a build name and operating system. This action creates a new build record and returns an Amazon S3 storage location (bucket and key only) and temporary access credentials. Use the credentials to manually upload your build file to the storage location (see the Amazon S3 topic Uploading Objects ). You can upload files to a location only once.

If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.

Build-related operations include:

• CreateBuild
• ListBuilds
• DescribeBuild
• UpdateBuild
• DeleteBuild

Creating a Request

createBuild :: CreateBuild

Creates a value of CreateBuild with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cbStorageLocation - 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, as well as a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in.
• cbOperatingSystem - 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. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
• cbName - Descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.
• cbVersion - Version that is associated with this build. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

data CreateBuild

Represents the input for a request action.

See: createBuild smart constructor.

Instances

Eq CreateBuild

Methods

(==) :: CreateBuild -> CreateBuild -> Bool

(/=) :: CreateBuild -> CreateBuild -> Bool

Data CreateBuild

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBuild -> c CreateBuild

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBuild

toConstr :: CreateBuild -> Constr

dataTypeOf :: CreateBuild -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateBuild)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBuild)

gmapT :: (forall b. Data b => b -> b) -> CreateBuild -> CreateBuild

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBuild -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBuild -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateBuild -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBuild -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBuild -> m CreateBuild

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBuild -> m CreateBuild

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBuild -> m CreateBuild

Read CreateBuild

Methods

readsPrec :: Int -> ReadS CreateBuild

readList :: ReadS [CreateBuild]

readPrec :: ReadPrec CreateBuild

readListPrec :: ReadPrec [CreateBuild]

Show CreateBuild

Methods

showsPrec :: Int -> CreateBuild -> ShowS

show :: CreateBuild -> String

showList :: [CreateBuild] -> ShowS

Generic CreateBuild

Associated Types

type Rep CreateBuild :: * -> *

Methods

from :: CreateBuild -> Rep CreateBuild x

to :: Rep CreateBuild x -> CreateBuild

Hashable CreateBuild

Methods

hashWithSalt :: Int -> CreateBuild -> Int

hash :: CreateBuild -> Int

ToJSON CreateBuild

Methods

toJSON :: CreateBuild -> Value

toEncoding :: CreateBuild -> Encoding

toJSONList :: [CreateBuild] -> Value

toEncodingList :: [CreateBuild] -> Encoding

NFData CreateBuild

Methods

rnf :: CreateBuild -> ()

AWSRequest CreateBuild

Associated Types

type Rs CreateBuild :: *

Methods

request :: CreateBuild -> Request CreateBuild

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateBuild -> ClientResponse -> m (Response CreateBuild)

ToHeaders CreateBuild

Methods

toHeaders :: CreateBuild -> [Header]

ToPath CreateBuild

Methods

toPath :: CreateBuild -> ByteString

ToQuery CreateBuild

Methods

toQuery :: CreateBuild -> QueryString

type Rep CreateBuild

type Rep CreateBuild = D1 * (MetaData "CreateBuild" "Network.AWS.GameLift.CreateBuild" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "CreateBuild'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cbStorageLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe S3Location))) (S1 * (MetaSel (Just Symbol "_cbOperatingSystem") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe OperatingSystem)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cbVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

type Rs CreateBuild

type Rs CreateBuild = CreateBuildResponse

Request Lenses

cbStorageLocation :: Lens' CreateBuild (Maybe S3Location)

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, as well as a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in.

cbOperatingSystem :: Lens' CreateBuild (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. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

cbName :: Lens' CreateBuild (Maybe Text)

Descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.

cbVersion :: Lens' CreateBuild (Maybe Text)

Version that is associated with this build. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

Destructuring the Response

createBuildResponse

Arguments

:: Int

cbrsResponseStatus

-> CreateBuildResponse

Creates a value of CreateBuildResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cbrsStorageLocation - Amazon S3 location for your game build file, including bucket name and key.
• cbrsUploadCredentials - This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials .
• cbrsBuild - The newly created build record, including a unique build ID and status.
• cbrsResponseStatus - -- | The response status code.

data CreateBuildResponse

Represents the returned data in response to a request action.

See: createBuildResponse smart constructor.

Instances

Eq CreateBuildResponse

Methods

(==) :: CreateBuildResponse -> CreateBuildResponse -> Bool

(/=) :: CreateBuildResponse -> CreateBuildResponse -> Bool

Data CreateBuildResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBuildResponse -> c CreateBuildResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBuildResponse

toConstr :: CreateBuildResponse -> Constr

dataTypeOf :: CreateBuildResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateBuildResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBuildResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateBuildResponse -> CreateBuildResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBuildResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBuildResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateBuildResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBuildResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBuildResponse -> m CreateBuildResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBuildResponse -> m CreateBuildResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBuildResponse -> m CreateBuildResponse

Show CreateBuildResponse

Methods

showsPrec :: Int -> CreateBuildResponse -> ShowS

show :: CreateBuildResponse -> String

showList :: [CreateBuildResponse] -> ShowS

Generic CreateBuildResponse

Associated Types

type Rep CreateBuildResponse :: * -> *

Methods

from :: CreateBuildResponse -> Rep CreateBuildResponse x

to :: Rep CreateBuildResponse x -> CreateBuildResponse

NFData CreateBuildResponse

Methods

rnf :: CreateBuildResponse -> ()

type Rep CreateBuildResponse

type Rep CreateBuildResponse = D1 * (MetaData "CreateBuildResponse" "Network.AWS.GameLift.CreateBuild" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "CreateBuildResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cbrsStorageLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe S3Location))) (S1 * (MetaSel (Just Symbol "_cbrsUploadCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive AWSCredentials))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbrsBuild") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Build))) (S1 * (MetaSel (Just Symbol "_cbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

cbrsStorageLocation :: Lens' CreateBuildResponse (Maybe S3Location)

Amazon S3 location for your game build file, including bucket name and key.

cbrsUploadCredentials :: Lens' CreateBuildResponse (Maybe AWSCredentials)

This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials .

cbrsBuild :: Lens' CreateBuildResponse (Maybe Build)

The newly created build record, including a unique build ID and status.

cbrsResponseStatus :: Lens' CreateBuildResponse Int

• - | The response status code.