Skip to content

/AWS1/CL_EBN=>UPDATECONFIGURATIONTEMPLATE()

About UpdateConfigurationTemplate

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

Method Signature

IMPORTING

Required arguments:

iv_applicationname TYPE /AWS1/EBNAPPLICATIONNAME /AWS1/EBNAPPLICATIONNAME

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

iv_templatename TYPE /AWS1/EBNCONFTEMPLATENAME /AWS1/EBNCONFTEMPLATENAME

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Optional arguments:

iv_description TYPE /AWS1/EBNDESCRIPTION /AWS1/EBNDESCRIPTION

A new description for the configuration.

it_optionsettings TYPE /AWS1/CL_EBNCONFOPTIONSETTING=>TT_CONFOPTIONSETTINGSLIST TT_CONFOPTIONSETTINGSLIST

A list of configuration option settings to update with the new specified option value.

it_optionstoremove TYPE /AWS1/CL_EBNOPTIONSPEC=>TT_OPTIONSSPECIFIERLIST TT_OPTIONSSPECIFIERLIST

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

RETURNING

oo_output TYPE REF TO /aws1/cl_ebnconfsettingsdesc /AWS1/CL_EBNCONFSETTINGSDESC

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->/aws1/if_ebn~updateconfigurationtemplate(
  it_optionsettings = VALUE /aws1/cl_ebnconfoptionsetting=>tt_confoptionsettingslist(
    (
      new /aws1/cl_ebnconfoptionsetting(
        iv_namespace = |string|
        iv_optionname = |string|
        iv_resourcename = |string|
        iv_value = |string|
      )
    )
  )
  it_optionstoremove = VALUE /aws1/cl_ebnoptionspec=>tt_optionsspecifierlist(
    (
      new /aws1/cl_ebnoptionspec(
        iv_namespace = |string|
        iv_optionname = |string|
        iv_resourcename = |string|
      )
    )
  )
  iv_applicationname = |string|
  iv_description = |string|
  iv_templatename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_solutionstackname = lo_result->get_solutionstackname( ).
  lv_platformarn = lo_result->get_platformarn( ).
  lv_applicationname = lo_result->get_applicationname( ).
  lv_configurationtemplatena = lo_result->get_templatename( ).
  lv_description = lo_result->get_description( ).
  lv_environmentname = lo_result->get_environmentname( ).
  lv_configurationdeployment = lo_result->get_deploymentstatus( ).
  lv_creationdate = lo_result->get_datecreated( ).
  lv_updatedate = lo_result->get_dateupdated( ).
  LOOP AT lo_result->get_optionsettings( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourcename = lo_row_1->get_resourcename( ).
      lv_optionnamespace = lo_row_1->get_namespace( ).
      lv_configurationoptionname = lo_row_1->get_optionname( ).
      lv_configurationoptionvalu = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To update a configuration template

The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:

DATA(lo_result) = lo_client->/aws1/if_ebn~updateconfigurationtemplate(
  it_optionstoremove = VALUE /aws1/cl_ebnoptionspec=>tt_optionsspecifierlist(
    (
      new /aws1/cl_ebnoptionspec(
        iv_namespace = |aws:elasticbeanstalk:healthreporting:system|
        iv_optionname = |ConfigDocument|
      )
    )
  )
  iv_applicationname = |my-app|
  iv_templatename = |my-template|
).