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 |
Updates a fleet's mutable attributes, including game session protection and resource creation limits.
To update fleet attributes, specify the fleet ID and the property values that you want to change.
If successful, an updated FleetAttributes
object is returned.
Learn more
Synopsis
- data UpdateFleetAttributes = UpdateFleetAttributes' {}
- newUpdateFleetAttributes :: Text -> UpdateFleetAttributes
- updateFleetAttributes_anywhereConfiguration :: Lens' UpdateFleetAttributes (Maybe AnywhereConfiguration)
- updateFleetAttributes_description :: Lens' UpdateFleetAttributes (Maybe Text)
- updateFleetAttributes_metricGroups :: Lens' UpdateFleetAttributes (Maybe [Text])
- updateFleetAttributes_name :: Lens' UpdateFleetAttributes (Maybe Text)
- updateFleetAttributes_newGameSessionProtectionPolicy :: Lens' UpdateFleetAttributes (Maybe ProtectionPolicy)
- updateFleetAttributes_resourceCreationLimitPolicy :: Lens' UpdateFleetAttributes (Maybe ResourceCreationLimitPolicy)
- updateFleetAttributes_fleetId :: Lens' UpdateFleetAttributes Text
- data UpdateFleetAttributesResponse = UpdateFleetAttributesResponse' {}
- newUpdateFleetAttributesResponse :: Int -> UpdateFleetAttributesResponse
- updateFleetAttributesResponse_fleetArn :: Lens' UpdateFleetAttributesResponse (Maybe Text)
- updateFleetAttributesResponse_fleetId :: Lens' UpdateFleetAttributesResponse (Maybe Text)
- updateFleetAttributesResponse_httpStatus :: Lens' UpdateFleetAttributesResponse Int
Creating a Request
data UpdateFleetAttributes Source #
See: newUpdateFleetAttributes
smart constructor.
UpdateFleetAttributes' | |
|
Instances
newUpdateFleetAttributes Source #
Create a value of UpdateFleetAttributes
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:
UpdateFleetAttributes
, updateFleetAttributes_anywhereConfiguration
- GameLift Anywhere configuration options.
UpdateFleetAttributes
, updateFleetAttributes_description
- A human-readable description of a fleet.
UpdateFleetAttributes
, updateFleetAttributes_metricGroups
- The name of a metric group to add this fleet to. Use a metric group in
Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide
an existing metric group name, or create a new metric group by providing
a new name. A fleet can only be in one metric group at a time.
UpdateFleetAttributes
, updateFleetAttributes_name
- A descriptive label that is associated with a fleet. Fleet names do not
need to be unique.
UpdateFleetAttributes
, updateFleetAttributes_newGameSessionProtectionPolicy
- The game session protection policy to apply to all new instances created
in this fleet. Instances that already exist are not affected. You can
set protection for individual instances using
UpdateGameSession
.
- NoProtection -- The game session can be terminated during a scale-down event.
- FullProtection -- If the game session is in an
ACTIVE
status, it cannot be terminated during a scale-down event.
UpdateFleetAttributes
, updateFleetAttributes_resourceCreationLimitPolicy
- Policy settings that limit the number of game sessions an individual
player can create over a span of time.
UpdateFleetAttributes
, updateFleetAttributes_fleetId
- A unique identifier for the fleet to update attribute metadata for. You
can use either the fleet ID or ARN value.
Request Lenses
updateFleetAttributes_anywhereConfiguration :: Lens' UpdateFleetAttributes (Maybe AnywhereConfiguration) Source #
GameLift Anywhere configuration options.
updateFleetAttributes_description :: Lens' UpdateFleetAttributes (Maybe Text) Source #
A human-readable description of a fleet.
updateFleetAttributes_metricGroups :: Lens' UpdateFleetAttributes (Maybe [Text]) Source #
The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.
updateFleetAttributes_name :: Lens' UpdateFleetAttributes (Maybe Text) Source #
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
updateFleetAttributes_newGameSessionProtectionPolicy :: Lens' UpdateFleetAttributes (Maybe ProtectionPolicy) Source #
The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession .
- NoProtection -- The game session can be terminated during a scale-down event.
- FullProtection -- If the game session is in an
ACTIVE
status, it cannot be terminated during a scale-down event.
updateFleetAttributes_resourceCreationLimitPolicy :: Lens' UpdateFleetAttributes (Maybe ResourceCreationLimitPolicy) Source #
Policy settings that limit the number of game sessions an individual player can create over a span of time.
updateFleetAttributes_fleetId :: Lens' UpdateFleetAttributes Text Source #
A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.
Destructuring the Response
data UpdateFleetAttributesResponse Source #
See: newUpdateFleetAttributesResponse
smart constructor.
UpdateFleetAttributesResponse' | |
|
Instances
newUpdateFleetAttributesResponse Source #
Create a value of UpdateFleetAttributesResponse
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:
UpdateFleetAttributesResponse
, updateFleetAttributesResponse_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
.
UpdateFleetAttributes
, updateFleetAttributesResponse_fleetId
- A unique identifier for the fleet that was updated.
$sel:httpStatus:UpdateFleetAttributesResponse'
, updateFleetAttributesResponse_httpStatus
- The response's http status code.
Response Lenses
updateFleetAttributesResponse_fleetArn :: Lens' UpdateFleetAttributesResponse (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
.
updateFleetAttributesResponse_fleetId :: Lens' UpdateFleetAttributesResponse (Maybe Text) Source #
A unique identifier for the fleet that was updated.
updateFleetAttributesResponse_httpStatus :: Lens' UpdateFleetAttributesResponse Int Source #
The response's http status code.