| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.GameLift.UpdateFleetAttributes
Description
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
Related actions
CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task
Synopsis
- data UpdateFleetAttributes = UpdateFleetAttributes' {}
- newUpdateFleetAttributes :: Text -> UpdateFleetAttributes
- updateFleetAttributes_newGameSessionProtectionPolicy :: Lens' UpdateFleetAttributes (Maybe ProtectionPolicy)
- updateFleetAttributes_name :: Lens' UpdateFleetAttributes (Maybe Text)
- updateFleetAttributes_metricGroups :: Lens' UpdateFleetAttributes (Maybe [Text])
- updateFleetAttributes_description :: Lens' UpdateFleetAttributes (Maybe Text)
- updateFleetAttributes_resourceCreationLimitPolicy :: Lens' UpdateFleetAttributes (Maybe ResourceCreationLimitPolicy)
- updateFleetAttributes_fleetId :: Lens' UpdateFleetAttributes Text
- data UpdateFleetAttributesResponse = UpdateFleetAttributesResponse' {
- fleetId :: Maybe Text
- httpStatus :: Int
- newUpdateFleetAttributesResponse :: Int -> UpdateFleetAttributesResponse
- updateFleetAttributesResponse_fleetId :: Lens' UpdateFleetAttributesResponse (Maybe Text)
- updateFleetAttributesResponse_httpStatus :: Lens' UpdateFleetAttributesResponse Int
Creating a Request
data UpdateFleetAttributes Source #
Represents the input for a request operation.
See: newUpdateFleetAttributes smart constructor.
Constructors
| UpdateFleetAttributes' | |
Fields
| |
Instances
newUpdateFleetAttributes Source #
Arguments
| :: Text | |
| -> UpdateFleetAttributes |
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:
$sel:newGameSessionProtectionPolicy':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
ACTIVEstatus, it cannot be terminated during a scale-down event.
$sel:name:UpdateFleetAttributes', updateFleetAttributes_name - A descriptive label that is associated with a fleet. Fleet names do not
need to be unique.
$sel:metricGroups: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.
$sel:description:UpdateFleetAttributes', updateFleetAttributes_description - A human-readable description of a fleet.
$sel:resourceCreationLimitPolicy:UpdateFleetAttributes', updateFleetAttributes_resourceCreationLimitPolicy - Policy settings that limit the number of game sessions an individual
player can create over a span of time.
$sel:fleetId: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_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
ACTIVEstatus, it cannot be terminated during a scale-down event.
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_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_description :: Lens' UpdateFleetAttributes (Maybe Text) Source #
A human-readable description of a fleet.
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 #
Represents the returned data in response to a request operation.
See: newUpdateFleetAttributesResponse smart constructor.
Constructors
| UpdateFleetAttributesResponse' | |
Fields
| |
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:
$sel:fleetId: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_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.