Skip to content

/AWS1/IF_ECS=>UPDATECLUSTER()

About UpdateCluster

Updates the cluster.

Method Signature

METHODS /AWS1/IF_ECS~UPDATECLUSTER
  IMPORTING
    !IV_CLUSTER TYPE /AWS1/ECSSTRING OPTIONAL
    !IT_SETTINGS TYPE /AWS1/CL_ECSCLUSTERSETTING=>TT_CLUSTERSETTINGS OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_ECSCLUSTERCONF OPTIONAL
    !IO_SERVICECONNECTDEFAULTS TYPE REF TO /AWS1/CL_ECSCLSTSVCCNCTDEFSREQ OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecsupdateclusterrsp
  RAISING
    /AWS1/CX_ECSCLIENTEXCEPTION
    /AWS1/CX_ECSCLUSTERNOTFOUNDEX
    /AWS1/CX_ECSINVALIDPARAMETEREX
    /AWS1/CX_ECSNAMESPACENOTFNDEX
    /AWS1/CX_ECSSERVEREXCEPTION
    /AWS1/CX_ECSCLIENTEXC
    /AWS1/CX_ECSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_cluster TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The name of the cluster to modify the settings for.

Optional arguments:

it_settings TYPE /AWS1/CL_ECSCLUSTERSETTING=>TT_CLUSTERSETTINGS TT_CLUSTERSETTINGS

The cluster settings for your cluster.

io_configuration TYPE REF TO /AWS1/CL_ECSCLUSTERCONF /AWS1/CL_ECSCLUSTERCONF

The execute command configuration for the cluster.

io_serviceconnectdefaults TYPE REF TO /AWS1/CL_ECSCLSTSVCCNCTDEFSREQ /AWS1/CL_ECSCLSTSVCCNCTDEFSREQ

Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_ecsupdateclusterrsp /AWS1/CL_ECSUPDATECLUSTERRSP

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->updatecluster(
  io_configuration = new /aws1/cl_ecsclusterconf(
    io_executecommandconf = new /aws1/cl_ecsexecutecommandconf(
      io_logconfiguration = new /aws1/cl_ecsexecutecmdlogconf(
        iv_cloudwatchencenabled = ABAP_TRUE
        iv_cloudwatchloggroupname = |string|
        iv_s3bucketname = |string|
        iv_s3encryptionenabled = ABAP_TRUE
        iv_s3keyprefix = |string|
      )
      iv_kmskeyid = |string|
      iv_logging = |string|
    )
    io_managedstorageconf = new /aws1/cl_ecsmanagedstorageconf(
      iv_fargateephemeralstrgkms00 = |string|
      iv_kmskeyid = |string|
    )
  )
  io_serviceconnectdefaults = new /aws1/cl_ecsclstsvccnctdefsreq( |string| )
  it_settings = VALUE /aws1/cl_ecsclustersetting=>tt_clustersettings(
    (
      new /aws1/cl_ecsclustersetting(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  iv_cluster = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_cluster = lo_result->get_cluster( ).
  IF lo_cluster IS NOT INITIAL.
    lv_string = lo_cluster->get_clusterarn( ).
    lv_string = lo_cluster->get_clustername( ).
    lo_clusterconfiguration = lo_cluster->get_configuration( ).
    IF lo_clusterconfiguration IS NOT INITIAL.
      lo_executecommandconfigura = lo_clusterconfiguration->get_executecommandconf( ).
      IF lo_executecommandconfigura IS NOT INITIAL.
        lv_string = lo_executecommandconfigura->get_kmskeyid( ).
        lv_executecommandlogging = lo_executecommandconfigura->get_logging( ).
        lo_executecommandlogconfig = lo_executecommandconfigura->get_logconfiguration( ).
        IF lo_executecommandlogconfig IS NOT INITIAL.
          lv_string = lo_executecommandlogconfig->get_cloudwatchloggroupname( ).
          lv_boolean = lo_executecommandlogconfig->get_cloudwatchencenabled( ).
          lv_string = lo_executecommandlogconfig->get_s3bucketname( ).
          lv_boolean = lo_executecommandlogconfig->get_s3encryptionenabled( ).
          lv_string = lo_executecommandlogconfig->get_s3keyprefix( ).
        ENDIF.
      ENDIF.
      lo_managedstorageconfigura = lo_clusterconfiguration->get_managedstorageconf( ).
      IF lo_managedstorageconfigura IS NOT INITIAL.
        lv_string = lo_managedstorageconfigura->get_kmskeyid( ).
        lv_string = lo_managedstorageconfigura->get_fargateephemeralstrgkm00( ).
      ENDIF.
    ENDIF.
    lv_string = lo_cluster->get_status( ).
    lv_integer = lo_cluster->get_regedcontainerinstscount( ).
    lv_integer = lo_cluster->get_runningtaskscount( ).
    lv_integer = lo_cluster->get_pendingtaskscount( ).
    lv_integer = lo_cluster->get_activeservicescount( ).
    LOOP AT lo_cluster->get_statistics( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_name( ).
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_cluster->get_tags( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_tagkey = lo_row_3->get_key( ).
        lv_tagvalue = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_cluster->get_settings( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_clustersettingname = lo_row_5->get_name( ).
        lv_string = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_cluster->get_capacityproviders( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_string = lo_row_7->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_cluster->get_defaultcappvdrstrategy( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_string = lo_row_9->get_capacityprovider( ).
        lv_capacityproviderstrateg = lo_row_9->get_weight( ).
        lv_capacityproviderstrateg_1 = lo_row_9->get_base( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_cluster->get_attachments( ) into lo_row_10.
      lo_row_11 = lo_row_10.
      IF lo_row_11 IS NOT INITIAL.
        lv_string = lo_row_11->get_id( ).
        lv_string = lo_row_11->get_type( ).
        lv_string = lo_row_11->get_status( ).
        LOOP AT lo_row_11->get_details( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_string = lo_row_1->get_name( ).
            lv_string = lo_row_1->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
    lv_string = lo_cluster->get_attachmentsstatus( ).
    lo_clusterserviceconnectde = lo_cluster->get_serviceconnectdefaults( ).
    IF lo_clusterserviceconnectde IS NOT INITIAL.
      lv_string = lo_clusterserviceconnectde->get_namespace( ).
    ENDIF.
  ENDIF.
ENDIF.

To update a cluster's observability settings.

This example turns on enhanced containerInsights in an existing cluster. 

DATA(lo_result) = lo_client->updatecluster(
  it_settings = VALUE /aws1/cl_ecsclustersetting=>tt_clustersettings(
    (
      new /aws1/cl_ecsclustersetting(
        iv_name = |containerInsights|
        iv_value = |enhanced|
      )
    )
  )
  iv_cluster = |ECS-project-update-cluster|
).

To update a cluster's Service Connect defaults.

This example sets a default Service Connect namespace. 

DATA(lo_result) = lo_client->updatecluster(
  io_serviceconnectdefaults = new /aws1/cl_ecsclstsvccnctdefsreq( |test| )
  iv_cluster = |ECS-project-update-cluster|
).