Network.AWS.GameLift.CreateBuild

Initializes a new build record and generates information required to upload a game build to Amazon GameLift. Once the build record has been created and its status is INITIALIZED , you can upload your game build.

Important: Do not use this API action unless you are using your own Amazon Simple Storage Service (Amazon S3) client and need to manually upload your build files. Instead, to create a build, use the CLI command upload-build , which creates a new build record and uploads the build files in one step. (See the Amazon GameLift Developer Guide help on packaging and uploading your build.)

To create a new build, identify the operating system of the game server binaries. All game servers in a build must use the same operating system. Optionally, specify a build name and version; this metadata is stored with other properties in the build record and is displayed in the GameLift console (it is not visible to players). If successful, this action returns the newly created build record along with the Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.

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 - Undocumented member.
• 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.
• cbName - Descriptive label associated with a build. Build names do not need to be unique. A build name can be changed later usingUpdateBuild .
• cbVersion - Version associated with this build. Version strings do not need to be unique to a build. A build version can be changed later usingUpdateBuild .

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 => Logger -> Service -> Proxy * CreateBuild -> ClientResponse -> m (Response CreateBuild)

ToPath CreateBuild

Methods

toPath :: CreateBuild -> ByteString

ToHeaders CreateBuild

Methods

toHeaders :: CreateBuild -> [Header]

ToQuery CreateBuild

Methods

toQuery :: CreateBuild -> QueryString

type Rep CreateBuild

type Rep CreateBuild = D1 (MetaData "CreateBuild" "Network.AWS.GameLift.CreateBuild" "amazonka-gamelift-1.4.5-2krZbzEaIqtLV8ATX8AZ52" 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)

Undocumented member.

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.

cbName :: Lens' CreateBuild (Maybe Text)

Descriptive label associated with a build. Build names do not need to be unique. A build name can be changed later usingUpdateBuild .

cbVersion :: Lens' CreateBuild (Maybe Text)

Version associated with this build. Version strings do not need to be unique to a build. A build version can be changed later usingUpdateBuild .

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 path and key, identifying where the game build files are stored.
• cbrsUploadCredentials - AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for. If you need to get fresh credentials, callRequestUploadCredentials .
• cbrsBuild - Set of properties for the newly created build.
• 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

Read CreateBuildResponse

Methods

readsPrec :: Int -> ReadS CreateBuildResponse

readList :: ReadS [CreateBuildResponse]

readPrec :: ReadPrec CreateBuildResponse

readListPrec :: ReadPrec [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.4.5-2krZbzEaIqtLV8ATX8AZ52" 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 DecidedUnpack) (Rec0 Int)))))

Response Lenses

cbrsStorageLocation :: Lens' CreateBuildResponse (Maybe S3Location)

Amazon S3 path and key, identifying where the game build files are stored.

cbrsUploadCredentials :: Lens' CreateBuildResponse (Maybe AWSCredentials)

AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for. If you need to get fresh credentials, callRequestUploadCredentials .

cbrsBuild :: Lens' CreateBuildResponse (Maybe Build)

Set of properties for the newly created build.

cbrsResponseStatus :: Lens' CreateBuildResponse Int

• - | The response status code.