/AWS1/IF_GML=>UPDATECONTAINERFLEET()

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

Method Signature

METHODS /AWS1/IF_GML~UPDATECONTAINERFLEET
  IMPORTING
    !IV_FLEETID TYPE /AWS1/GMLFLEETIDORARN OPTIONAL
    !IV_GAMESERVERCONTAINERGRDE01 TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00 OPTIONAL
    !IV_PERINSTCONTAINERGRPDEFN00 TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00 OPTIONAL
    !IV_GAMESERVERCONTAINERGRSP00 TYPE /AWS1/GMLGAMESERVERCONTAINER00 OPTIONAL
    !IO_INSTANCECONNPORTRANGE TYPE REF TO /AWS1/CL_GMLCONNPORTRANGE OPTIONAL
    !IT_INSTANCEINBOUNDPERMAUTHS TYPE /AWS1/CL_GMLIPPERMISSION=>TT_IPPERMISSIONSLIST OPTIONAL
    !IT_INSTINBOUNDPERMREVOCATI00 TYPE /AWS1/CL_GMLIPPERMISSION=>TT_IPPERMISSIONSLIST OPTIONAL
    !IO_DEPLOYMENTCONFIGURATION TYPE REF TO /AWS1/CL_GMLDEPLOYMENTCONF OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/GMLNONZEROANDMAXSTRING OPTIONAL
    !IT_METRICGROUPS TYPE /AWS1/CL_GMLMETRICGROUPLIST_W=>TT_METRICGROUPLIST OPTIONAL
    !IV_NEWGAMESESSPROTECTIONPLY TYPE /AWS1/GMLPROTECTIONPOLICY OPTIONAL
    !IO_GAMESESSCREATIONLIMITPLY TYPE REF TO /AWS1/CL_GMLGAMESESSCREATION00 OPTIONAL
    !IO_LOGCONFIGURATION TYPE REF TO /AWS1/CL_GMLLOGCONFIGURATION OPTIONAL
    !IT_REMOVEATTRIBUTES TYPE /AWS1/CL_GMLCONTAINERFLEETRE00=>TT_CONTAINERFLEETREMATTRLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmlupcontainerfleet01
  RAISING
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLLIMITEXCEEDEDEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLNOTREADYEXCEPTION
    /AWS1/CX_GMLUNAUTHORIZEDEX
    /AWS1/CX_GMLUNSUPPEDREGIONEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_fleetid TYPE /AWS1/GMLFLEETIDORARN /AWS1/GMLFLEETIDORARN

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

Optional arguments:

iv_gameservercontainergrde01 TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00 /AWS1/GMLCONTAINERGRDEFNAMEO00

The name or ARN value of a new game server container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value. You can't remove a fleet's game server container group definition, you can only update or replace it with another definition.

Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

iv_perinstcontainergrpdefn00 TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00 /AWS1/GMLCONTAINERGRDEFNAMEO00

The name or ARN value of a new per-instance container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value.

Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.

To remove a fleet's per-instance container group definition, leave this parameter empty and use the parameter RemoveAttributes.

iv_gameservercontainergrsp00 TYPE /AWS1/GMLGAMESERVERCONTAINER00 /AWS1/GMLGAMESERVERCONTAINER00

The number of times to replicate the game server container group on each fleet instance. By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. You can remove this property value to use the calculated value, or set it manually. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.

io_instanceconnportrange TYPE REF TO /AWS1/CL_GMLCONNPORTRANGE /AWS1/CL_GMLCONNPORTRANGE

A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. If you previously set this parameter manually, you can't reset this to use the calculated settings.

it_instanceinboundpermauths TYPE /AWS1/CL_GMLIPPERMISSION=>TT_IPPERMISSIONSLIST TT_IPPERMISSIONSLIST

A set of ports to add to the container fleet's inbound permissions.

it_instinboundpermrevocati00 TYPE /AWS1/CL_GMLIPPERMISSION=>TT_IPPERMISSIONSLIST TT_IPPERMISSIONSLIST

A set of ports to remove from the container fleet's inbound permissions.

io_deploymentconfiguration TYPE REF TO /AWS1/CL_GMLDEPLOYMENTCONF /AWS1/CL_GMLDEPLOYMENTCONF

Instructions for how to deploy updates to a container fleet, if the fleet update initiates a deployment. The deployment configuration lets you determine how to replace fleet instances and what actions to take if the deployment fails.

iv_description TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

A meaningful description of the container fleet.

it_metricgroups TYPE /AWS1/CL_GMLMETRICGROUPLIST_W=>TT_METRICGROUPLIST TT_METRICGROUPLIST

The name of an Amazon Web Services CloudWatch metric group to add this fleet to.

iv_newgamesessprotectionply TYPE /AWS1/GMLPROTECTIONPOLICY /AWS1/GMLPROTECTIONPOLICY

The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected.

io_gamesesscreationlimitply TYPE REF TO /AWS1/CL_GMLGAMESESSCREATION00 /AWS1/CL_GMLGAMESESSCREATION00

A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.

io_logconfiguration TYPE REF TO /AWS1/CL_GMLLOGCONFIGURATION /AWS1/CL_GMLLOGCONFIGURATION

The method for collecting container logs for the fleet.

it_removeattributes TYPE /AWS1/CL_GMLCONTAINERFLEETRE00=>TT_CONTAINERFLEETREMATTRLIST TT_CONTAINERFLEETREMATTRLIST

If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition.

RETURNING

oo_output TYPE REF TO /aws1/cl_gmlupcontainerfleet01 /AWS1/CL_GMLUPCONTAINERFLEET01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatecontainerfleet(
  io_deploymentconfiguration = new /aws1/cl_gmldeploymentconf(
    iv_impairmentstrategy = |string|
    iv_minimumhealthypercentage = 123
    iv_protectionstrategy = |string|
  )
  io_gamesesscreationlimitply = new /aws1/cl_gmlgamesesscreation00(
    iv_newgamesessionspercreator = 123
    iv_policyperiodinminutes = 123
  )
  io_instanceconnportrange = new /aws1/cl_gmlconnportrange(
    iv_fromport = 123
    iv_toport = 123
  )
  io_logconfiguration = new /aws1/cl_gmllogconfiguration(
    iv_logdestination = |string|
    iv_loggrouparn = |string|
    iv_s3bucketname = |string|
  )
  it_instanceinboundpermauths = VALUE /aws1/cl_gmlippermission=>tt_ippermissionslist(
    (
      new /aws1/cl_gmlippermission(
        iv_fromport = 123
        iv_iprange = |string|
        iv_protocol = |string|
        iv_toport = 123
      )
    )
  )
  it_instinboundpermrevocati00 = VALUE /aws1/cl_gmlippermission=>tt_ippermissionslist(
    (
      new /aws1/cl_gmlippermission(
        iv_fromport = 123
        iv_iprange = |string|
        iv_protocol = |string|
        iv_toport = 123
      )
    )
  )
  it_metricgroups = VALUE /aws1/cl_gmlmetricgrouplist_w=>tt_metricgrouplist(
    ( new /aws1/cl_gmlmetricgrouplist_w( |string| ) )
  )
  it_removeattributes = VALUE /aws1/cl_gmlcontainerfleetre00=>tt_containerfleetremattrlist(
    ( new /aws1/cl_gmlcontainerfleetre00( |string| ) )
  )
  iv_description = |string|
  iv_fleetid = |string|
  iv_gameservercontainergrde01 = |string|
  iv_gameservercontainergrsp00 = 123
  iv_newgamesessprotectionply = |string|
  iv_perinstcontainergrpdefn00 = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_containerfleet = lo_result->get_containerfleet( ).
  IF lo_containerfleet IS NOT INITIAL.
    lv_fleetid = lo_containerfleet->get_fleetid( ).
    lv_fleetarn = lo_containerfleet->get_fleetarn( ).
    lv_iamrolearn = lo_containerfleet->get_fleetrolearn( ).
    lv_containergroupdefinitio = lo_containerfleet->get_gameservercontainergrd01( ).
    lv_containergroupdefinitio_1 = lo_containerfleet->get_gameservercontainergrd00( ).
    lv_containergroupdefinitio = lo_containerfleet->get_perinstcontainergrpdef00( ).
    lv_containergroupdefinitio_1 = lo_containerfleet->get_perinstcontainergrdefn00( ).
    lo_connectionportrange = lo_containerfleet->get_instanceconnportrange( ).
    IF lo_connectionportrange IS NOT INITIAL.
      lv_portnumber = lo_connectionportrange->get_fromport( ).
      lv_portnumber = lo_connectionportrange->get_toport( ).
    ENDIF.
    LOOP AT lo_containerfleet->get_instanceinboundperms( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_portnumber = lo_row_1->get_fromport( ).
        lv_portnumber = lo_row_1->get_toport( ).
        lv_iprange = lo_row_1->get_iprange( ).
        lv_ipprotocol = lo_row_1->get_protocol( ).
      ENDIF.
    ENDLOOP.
    lv_gameservercontainergrou = lo_containerfleet->get_gameservercontainergrs00( ).
    lv_maximumgameservercontai = lo_containerfleet->get_maxgameservercontainer00( ).
    lv_nonzeroandmaxstring = lo_containerfleet->get_instancetype( ).
    lv_containerfleetbillingty = lo_containerfleet->get_billingtype( ).
    lv_nonzeroandmaxstring = lo_containerfleet->get_description( ).
    lv_timestamp = lo_containerfleet->get_creationtime( ).
    LOOP AT lo_containerfleet->get_metricgroups( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_metricgroup = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_protectionpolicy = lo_containerfleet->get_newgamesessprotectionply( ).
    lo_gamesessioncreationlimi = lo_containerfleet->get_gamesesscreationlimitply( ).
    IF lo_gamesessioncreationlimi IS NOT INITIAL.
      lv_wholenumber = lo_gamesessioncreationlimi->get_newgamesessspercreator( ).
      lv_wholenumber = lo_gamesessioncreationlimi->get_policyperiodinminutes( ).
    ENDIF.
    lv_containerfleetstatus = lo_containerfleet->get_status( ).
    lo_deploymentdetails = lo_containerfleet->get_deploymentdetails( ).
    IF lo_deploymentdetails IS NOT INITIAL.
      lv_deploymentid = lo_deploymentdetails->get_latestdeploymentid( ).
    ENDIF.
    lo_logconfiguration = lo_containerfleet->get_logconfiguration( ).
    IF lo_logconfiguration IS NOT INITIAL.
      lv_logdestination = lo_logconfiguration->get_logdestination( ).
      lv_nonemptystring = lo_logconfiguration->get_s3bucketname( ).
      lv_loggrouparnstringmodel = lo_logconfiguration->get_loggrouparn( ).
    ENDIF.
    LOOP AT lo_containerfleet->get_locationattributes( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_locationstringmodel = lo_row_5->get_location( ).
        lv_containerfleetlocations = lo_row_5->get_status( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.