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.CreateFleetLocations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.

This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature and were created after the feature was released in March 2021.

To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.

If successful, this operation returns the list of added locations with their status set to NEW. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.

Learn more

Setting up fleets

Multi-location fleets

Synopsis

Creating a Request

data CreateFleetLocations Source #

See: newCreateFleetLocations smart constructor.

Constructors

CreateFleetLocations'

Fields

fleetId :: Text
A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.
locations :: NonEmpty LocationConfiguration
A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.

Instances

Instances details

ToJSON CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods toJSON :: CreateFleetLocations -> Value # toEncoding :: CreateFleetLocations -> Encoding # toJSONList :: [CreateFleetLocations] -> Value # toEncodingList :: [CreateFleetLocations] -> Encoding #
ToHeaders CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods toHeaders :: CreateFleetLocations -> [Header] #
ToPath CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods toPath :: CreateFleetLocations -> ByteString #
ToQuery CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods toQuery :: CreateFleetLocations -> QueryString #
AWSRequest CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Associated Types type AWSResponse CreateFleetLocations # Methods request :: (Service -> Service) -> CreateFleetLocations -> Request CreateFleetLocations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFleetLocations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFleetLocations))) #
Generic CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Associated Types type Rep CreateFleetLocations :: Type -> Type # Methods from :: CreateFleetLocations -> Rep CreateFleetLocations x # to :: Rep CreateFleetLocations x -> CreateFleetLocations #
Read CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods readsPrec :: Int -> ReadS CreateFleetLocations # readList :: ReadS [CreateFleetLocations] # readPrec :: ReadPrec CreateFleetLocations # readListPrec :: ReadPrec [CreateFleetLocations] #
Show CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods showsPrec :: Int -> CreateFleetLocations -> ShowS # show :: CreateFleetLocations -> String # showList :: [CreateFleetLocations] -> ShowS #
NFData CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods rnf :: CreateFleetLocations -> () #
Eq CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods (==) :: CreateFleetLocations -> CreateFleetLocations -> Bool # (/=) :: CreateFleetLocations -> CreateFleetLocations -> Bool #
Hashable CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods hashWithSalt :: Int -> CreateFleetLocations -> Int # hash :: CreateFleetLocations -> Int #
type AWSResponse CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations type AWSResponse CreateFleetLocations = CreateFleetLocationsResponse
type Rep CreateFleetLocations Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations type Rep CreateFleetLocations = D1 ('MetaData "CreateFleetLocations" "Amazonka.GameLift.CreateFleetLocations" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "CreateFleetLocations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "locations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty LocationConfiguration))))

newCreateFleetLocations Source #

Arguments

:: Text	`CreateFleetLocations`
-> NonEmpty LocationConfiguration	`$sel:locations:CreateFleetLocations'`
-> CreateFleetLocations

Create a value of CreateFleetLocations 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:

CreateFleetLocations, createFleetLocations_fleetId - A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.

$sel:locations:CreateFleetLocations', createFleetLocations_locations - A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.

Request Lenses

createFleetLocations_fleetId :: Lens' CreateFleetLocations Text Source #

A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.

createFleetLocations_locations :: Lens' CreateFleetLocations (NonEmpty LocationConfiguration) Source #

A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.

Destructuring the Response

data CreateFleetLocationsResponse Source #

See: newCreateFleetLocationsResponse smart constructor.

Constructors

CreateFleetLocationsResponse'

Fields

fleetArn :: Maybe Text
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
fleetId :: Maybe Text
A unique identifier for the fleet that was updated with new locations.
locationStates :: Maybe [LocationState]
The remote locations that are being added to the fleet, and the life-cycle status of each location. For new locations, the status is set to NEW. During location creation, GameLift updates each location's status as instances are deployed there and prepared for game hosting. This list does not include the fleet home Region or any remote locations that were already added to the fleet.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Associated Types type Rep CreateFleetLocationsResponse :: Type -> Type # Methods from :: CreateFleetLocationsResponse -> Rep CreateFleetLocationsResponse x # to :: Rep CreateFleetLocationsResponse x -> CreateFleetLocationsResponse #
Read CreateFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods readsPrec :: Int -> ReadS CreateFleetLocationsResponse # readList :: ReadS [CreateFleetLocationsResponse] # readPrec :: ReadPrec CreateFleetLocationsResponse # readListPrec :: ReadPrec [CreateFleetLocationsResponse] #
Show CreateFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods showsPrec :: Int -> CreateFleetLocationsResponse -> ShowS # show :: CreateFleetLocationsResponse -> String # showList :: [CreateFleetLocationsResponse] -> ShowS #
NFData CreateFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods rnf :: CreateFleetLocationsResponse -> () #
Eq CreateFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations Methods (==) :: CreateFleetLocationsResponse -> CreateFleetLocationsResponse -> Bool # (/=) :: CreateFleetLocationsResponse -> CreateFleetLocationsResponse -> Bool #
type Rep CreateFleetLocationsResponse Source #
Instance details Defined in Amazonka.GameLift.CreateFleetLocations type Rep CreateFleetLocationsResponse = D1 ('MetaData "CreateFleetLocationsResponse" "Amazonka.GameLift.CreateFleetLocations" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "CreateFleetLocationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fleetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "locationStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocationState])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateFleetLocationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFleetLocationsResponse'`
-> CreateFleetLocationsResponse

Create a value of CreateFleetLocationsResponse 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:

CreateFleetLocationsResponse, createFleetLocationsResponse_fleetArn - The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

CreateFleetLocations, createFleetLocationsResponse_fleetId - A unique identifier for the fleet that was updated with new locations.

$sel:locationStates:CreateFleetLocationsResponse', createFleetLocationsResponse_locationStates - The remote locations that are being added to the fleet, and the life-cycle status of each location. For new locations, the status is set to NEW. During location creation, GameLift updates each location's status as instances are deployed there and prepared for game hosting. This list does not include the fleet home Region or any remote locations that were already added to the fleet.

$sel:httpStatus:CreateFleetLocationsResponse', createFleetLocationsResponse_httpStatus - The response's http status code.

Response Lenses

createFleetLocationsResponse_fleetArn :: Lens' CreateFleetLocationsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

createFleetLocationsResponse_fleetId :: Lens' CreateFleetLocationsResponse (Maybe Text) Source #

A unique identifier for the fleet that was updated with new locations.

createFleetLocationsResponse_locationStates :: Lens' CreateFleetLocationsResponse (Maybe [LocationState]) Source #

The remote locations that are being added to the fleet, and the life-cycle status of each location. For new locations, the status is set to NEW. During location creation, GameLift updates each location's status as instances are deployed there and prepared for game hosting. This list does not include the fleet home Region or any remote locations that were already added to the fleet.

createFleetLocationsResponse_httpStatus :: Lens' CreateFleetLocationsResponse Int Source #

The response's http status code.