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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:

Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling.
Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.

This operation can be used in the following ways:

To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status.
To update capacity for a fleet's remote location, include the Location parameter set to the location to be updated. The location must be in ACTIVE status.

If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's limit, the LimitExceeded exception occurs.

Learn more

Scaling fleet capacity

Synopsis

data UpdateFleetCapacity = UpdateFleetCapacity' {
- desiredInstances :: Maybe Natural
- location :: Maybe Text
- maxSize :: Maybe Natural
- minSize :: Maybe Natural
- fleetId :: Text
}
newUpdateFleetCapacity :: Text -> UpdateFleetCapacity
updateFleetCapacity_desiredInstances :: Lens' UpdateFleetCapacity (Maybe Natural)
updateFleetCapacity_location :: Lens' UpdateFleetCapacity (Maybe Text)
updateFleetCapacity_maxSize :: Lens' UpdateFleetCapacity (Maybe Natural)
updateFleetCapacity_minSize :: Lens' UpdateFleetCapacity (Maybe Natural)
updateFleetCapacity_fleetId :: Lens' UpdateFleetCapacity Text
data UpdateFleetCapacityResponse = UpdateFleetCapacityResponse' {
- fleetArn :: Maybe Text
- fleetId :: Maybe Text
- location :: Maybe Text
- httpStatus :: Int
}
newUpdateFleetCapacityResponse :: Int -> UpdateFleetCapacityResponse
updateFleetCapacityResponse_fleetArn :: Lens' UpdateFleetCapacityResponse (Maybe Text)
updateFleetCapacityResponse_fleetId :: Lens' UpdateFleetCapacityResponse (Maybe Text)
updateFleetCapacityResponse_location :: Lens' UpdateFleetCapacityResponse (Maybe Text)
updateFleetCapacityResponse_httpStatus :: Lens' UpdateFleetCapacityResponse Int

Creating a Request

data UpdateFleetCapacity Source #

See: newUpdateFleetCapacity smart constructor.

Constructors

UpdateFleetCapacity'

Fields

desiredInstances :: Maybe Natural
The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
location :: Maybe Text
The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as us-west-2.
maxSize :: Maybe Natural
The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
minSize :: Maybe Natural
The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
fleetId :: Text
A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.

Instances

Instances details

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

newUpdateFleetCapacity Source #

Arguments

:: Text	`UpdateFleetCapacity`
-> UpdateFleetCapacity

Create a value of UpdateFleetCapacity 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:desiredInstances:UpdateFleetCapacity', updateFleetCapacity_desiredInstances - The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.

UpdateFleetCapacity, updateFleetCapacity_location - The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as us-west-2.

$sel:maxSize:UpdateFleetCapacity', updateFleetCapacity_maxSize - The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.

$sel:minSize:UpdateFleetCapacity', updateFleetCapacity_minSize - The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.

UpdateFleetCapacity, updateFleetCapacity_fleetId - A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.

Request Lenses

updateFleetCapacity_desiredInstances :: Lens' UpdateFleetCapacity (Maybe Natural) Source #

The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.

updateFleetCapacity_location :: Lens' UpdateFleetCapacity (Maybe Text) Source #

The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as us-west-2.

updateFleetCapacity_maxSize :: Lens' UpdateFleetCapacity (Maybe Natural) Source #

The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.

updateFleetCapacity_minSize :: Lens' UpdateFleetCapacity (Maybe Natural) Source #

The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.

updateFleetCapacity_fleetId :: Lens' UpdateFleetCapacity Text Source #

A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.

Destructuring the Response

data UpdateFleetCapacityResponse Source #

See: newUpdateFleetCapacityResponse smart constructor.

Constructors

UpdateFleetCapacityResponse'

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.
location :: Maybe Text
The remote location being updated, expressed as an Amazon Web Services Region code, such as us-west-2.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateFleetCapacityResponse Source #

Arguments

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

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

UpdateFleetCapacityResponse, updateFleetCapacityResponse_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.

UpdateFleetCapacity, updateFleetCapacityResponse_fleetId - A unique identifier for the fleet that was updated.

UpdateFleetCapacity, updateFleetCapacityResponse_location - The remote location being updated, expressed as an Amazon Web Services Region code, such as us-west-2.

$sel:httpStatus:UpdateFleetCapacityResponse', updateFleetCapacityResponse_httpStatus - The response's http status code.

Response Lenses

updateFleetCapacityResponse_fleetArn :: Lens' UpdateFleetCapacityResponse (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.

updateFleetCapacityResponse_fleetId :: Lens' UpdateFleetCapacityResponse (Maybe Text) Source #

A unique identifier for the fleet that was updated.

updateFleetCapacityResponse_location :: Lens' UpdateFleetCapacityResponse (Maybe Text) Source #

The remote location being updated, expressed as an Amazon Web Services Region code, such as us-west-2.

updateFleetCapacityResponse_httpStatus :: Lens' UpdateFleetCapacityResponse Int Source #

The response's http status code.