DESCRIBECONFSETTINGS()`¶

About DescribeConfigurationSettings¶

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Method Signature¶

METHODS /AWS1/IF_EBN~DESCRIBECONFSETTINGS
  IMPORTING
    !IV_APPLICATIONNAME TYPE /AWS1/EBNAPPLICATIONNAME OPTIONAL
    !IV_TEMPLATENAME TYPE /AWS1/EBNCONFTEMPLATENAME OPTIONAL
    !IV_ENVIRONMENTNAME TYPE /AWS1/EBNENVIRONMENTNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ebnconfsettingsdescs
  RAISING
    /AWS1/CX_EBNTOOMANYBUCKETSEX
    /AWS1/CX_EBNCLIENTEXC
    /AWS1/CX_EBNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_applicationname` `TYPE /AWS1/EBNAPPLICATIONNAME` `/AWS1/EBNAPPLICATIONNAME`¶

The application for the environment or configuration template.

Optional arguments:¶

`iv_templatename` `TYPE /AWS1/EBNCONFTEMPLATENAME` `/AWS1/EBNCONFTEMPLATENAME`¶

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

`iv_environmentname` `TYPE /AWS1/EBNENVIRONMENTNAME` `/AWS1/EBNENVIRONMENTNAME`¶

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ebnconfsettingsdescs` `/AWS1/CL_EBNCONFSETTINGSDESCS`¶

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->describeconfsettings(
  iv_applicationname = |string|
  iv_environmentname = |string|
  iv_templatename = |string|
).

This is an example of reading all possible response values

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

To view configurations settings for an environment¶

The following operation retrieves configuration settings for an environment named my-env:

DATA(lo_result) = lo_client->describeconfsettings(
  iv_applicationname = |my-app|
  iv_environmentname = |my-env|
).

/AWS1/IF_EBN=>DESCRIBECONFSETTINGS()¶