UpdateContainerFleet (smaws-clients.Smaws_Client

Module Smaws_Client_GameLift.UpdateContainerFleet

This API works with the following fleet types: Container

Updates the properties of a managed container fleet. Depending on the properties being updated, this operation might initiate a fleet deployment. You can track deployments for a fleet using https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetDeployment.html.

A managed fleet's runtime environment, which depends on the fleet's Amazon Machine Image {AMI} version, can't be updated. You must create a new fleet. As a best practice, we recommend replacing your managed fleets every 30 days to maintain a secure and up-to-date runtime environment for your hosted game servers. For guidance, see Security best practices for Amazon GameLift Servers.

Request options

As with CreateContainerFleet, many fleet properties use common defaults or are calculated based on the fleet's container group definitions.

Update fleet properties that result in a fleet deployment. Include only those properties that you want to change. Specify deployment configuration settings.

Update fleet properties that don't result in a fleet deployment. Include only those properties that you want to change.

Changes to the following properties initiate a fleet deployment:

GameServerContainerGroupDefinition

PerInstanceContainerGroupDefinition

GameServerContainerGroupsPerInstance

InstanceInboundPermissions

InstanceConnectionPortRange

LogConfiguration

Results

If successful, this operation updates the container fleet resource, and might initiate a new deployment of fleet resources using the deployment configuration provided. A deployment replaces existing fleet instances with new instances that are deployed with the updated fleet properties. The fleet is placed in UPDATING status until the deployment is complete, then return to ACTIVE.

You can have only one update deployment active at a time for a fleet. If a second update request initiates a deployment while another deployment is in progress, the first deployment is cancelled.

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `InternalServiceException of Types.internal_service_exception
  | `InvalidRequestException of Types.invalid_request_exception
  | `LimitExceededException of Types.limit_exceeded_exception
  | `NotFoundException of Types.not_found_exception
  | `NotReadyException of Types.not_ready_exception
  | `UnauthorizedException of Types.unauthorized_exception
  | `UnsupportedRegionException of Types.unsupported_region_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.update_container_fleet_input ->
  (Types.update_container_fleet_output,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `LimitExceededException of Types.limit_exceeded_exception
    | `NotFoundException of Types.not_found_exception
    | `NotReadyException of Types.not_ready_exception
    | `UnauthorizedException of Types.unauthorized_exception
    | `UnsupportedRegionException of Types.unsupported_region_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.update_container_fleet_input ->
  (Types.update_container_fleet_output Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `LimitExceededException of Types.limit_exceeded_exception
    | `NotFoundException of Types.not_found_exception
    | `NotReadyException of Types.not_ready_exception
    | `UnauthorizedException of Types.unauthorized_exception
    | `UnsupportedRegionException of Types.unsupported_region_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result