amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

Setting up GameLift fleets

Synopsis

Creating a Request

data UpdateFleetAttributes Source #

See: newUpdateFleetAttributes smart constructor.

Constructors

UpdateFleetAttributes' 

Fields

  • anywhereConfiguration :: Maybe AnywhereConfiguration

    GameLift Anywhere configuration options.

  • description :: Maybe Text

    A human-readable description of a fleet.

  • metricGroups :: Maybe [Text]

    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.

  • name :: Maybe Text

    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

  • newGameSessionProtectionPolicy' :: Maybe ProtectionPolicy

    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.
  • resourceCreationLimitPolicy :: Maybe ResourceCreationLimitPolicy

    Policy settings that limit the number of game sessions an individual player can create over a span of time.

  • fleetId :: Text

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

Instances

Instances details
ToJSON UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

toJSON :: UpdateFleetAttributes -> Value #

toEncoding :: UpdateFleetAttributes -> Encoding #

toJSONList :: [UpdateFleetAttributes] -> Value #

toEncodingList :: [UpdateFleetAttributes] -> Encoding #

ToHeaders UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

toHeaders :: UpdateFleetAttributes -> [Header] #

ToPath UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

toPath :: UpdateFleetAttributes -> ByteString #

ToQuery UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

toQuery :: UpdateFleetAttributes -> QueryString #

AWSRequest UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Associated Types

type AWSResponse UpdateFleetAttributes #

Methods

request :: (Service -> Service) -> UpdateFleetAttributes -> Request UpdateFleetAttributes #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateFleetAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFleetAttributes))) #

Generic UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Associated Types

type Rep UpdateFleetAttributes :: Type -> Type #

Methods

from :: UpdateFleetAttributes -> Rep UpdateFleetAttributes x #

to :: Rep UpdateFleetAttributes x -> UpdateFleetAttributes #

Read UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

readsPrec :: Int -> ReadS UpdateFleetAttributes #

readList :: ReadS [UpdateFleetAttributes] #

readPrec :: ReadPrec UpdateFleetAttributes #

readListPrec :: ReadPrec [UpdateFleetAttributes] #

Show UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

showsPrec :: Int -> UpdateFleetAttributes -> ShowS #

show :: UpdateFleetAttributes -> String #

showList :: [UpdateFleetAttributes] -> ShowS #

NFData UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

rnf :: UpdateFleetAttributes -> () #

Eq UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

(==) :: UpdateFleetAttributes -> UpdateFleetAttributes -> Bool #

(/=) :: UpdateFleetAttributes -> UpdateFleetAttributes -> Bool #

Hashable UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

hashWithSalt :: Int -> UpdateFleetAttributes -> Int #

hash :: UpdateFleetAttributes -> Int #

type AWSResponse UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

type AWSResponse UpdateFleetAttributes = UpdateFleetAttributesResponse
type Rep UpdateFleetAttributes Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

type Rep UpdateFleetAttributes = D1 ('MetaData "UpdateFleetAttributes" "Amazonka.GameLift.UpdateFleetAttributes" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateFleetAttributes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "anywhereConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnywhereConfiguration)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metricGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "newGameSessionProtectionPolicy'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtectionPolicy))) :*: (S1 ('MetaSel ('Just "resourceCreationLimitPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceCreationLimitPolicy)) :*: S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateFleetAttributes Source #

Arguments

:: Text

UpdateFleetAttributes

-> 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:

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.

Constructors

UpdateFleetAttributesResponse' 

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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Associated Types

type Rep UpdateFleetAttributesResponse :: Type -> Type #

Methods

from :: UpdateFleetAttributesResponse -> Rep UpdateFleetAttributesResponse x #

to :: Rep UpdateFleetAttributesResponse x -> UpdateFleetAttributesResponse #

Read UpdateFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

readsPrec :: Int -> ReadS UpdateFleetAttributesResponse #

readList :: ReadS [UpdateFleetAttributesResponse] #

readPrec :: ReadPrec UpdateFleetAttributesResponse #

readListPrec :: ReadPrec [UpdateFleetAttributesResponse] #

Show UpdateFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

showsPrec :: Int -> UpdateFleetAttributesResponse -> ShowS #

show :: UpdateFleetAttributesResponse -> String #

showList :: [UpdateFleetAttributesResponse] -> ShowS #

NFData UpdateFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

rnf :: UpdateFleetAttributesResponse -> () #

Eq UpdateFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

Methods

(==) :: UpdateFleetAttributesResponse -> UpdateFleetAttributesResponse -> Bool #

(/=) :: UpdateFleetAttributesResponse -> UpdateFleetAttributesResponse -> Bool #

type Rep UpdateFleetAttributesResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateFleetAttributes

type Rep UpdateFleetAttributesResponse = D1 ('MetaData "UpdateFleetAttributesResponse" "Amazonka.GameLift.UpdateFleetAttributes" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateFleetAttributesResponse'" '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateFleetAttributesResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateFleetAttributesResponse'

-> UpdateFleetAttributesResponse 

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.