CREATEBACKUP()`¶

About CreateBackup¶

Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.

Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.

This operation is asynchronous.

A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_servername` `TYPE /AWS1/OWCSERVERNAME` `/AWS1/OWCSERVERNAME`¶

The name of the server that you want to back up.

Optional arguments:¶

`iv_description` `TYPE /AWS1/OWCSTRING` `/AWS1/OWCSTRING`¶

A user-defined description of the backup.

`it_tags` `TYPE /AWS1/CL_OWCTAG=>TT_TAGLIST` `TT_TAGLIST`¶

A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.

The key cannot be empty.

The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

Leading and trailing white spaces are trimmed from both the key and value.

A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_owccreatebackuprsp` `/AWS1/CL_OWCCREATEBACKUPRSP`¶

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_owc~createbackup(
  it_tags = VALUE /aws1/cl_owctag=>tt_taglist(
    (
      new /aws1/cl_owctag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
  iv_servername = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_backup = lo_result->get_backup( ).
  IF lo_backup IS NOT INITIAL.
    lv_string = lo_backup->get_backuparn( ).
    lv_backupid = lo_backup->get_backupid( ).
    lv_backuptype = lo_backup->get_backuptype( ).
    lv_timestamp = lo_backup->get_createdat( ).
    lv_string = lo_backup->get_description( ).
    lv_string = lo_backup->get_engine( ).
    lv_string = lo_backup->get_enginemodel( ).
    lv_string = lo_backup->get_engineversion( ).
    lv_string = lo_backup->get_instanceprofilearn( ).
    lv_string = lo_backup->get_instancetype( ).
    lv_string = lo_backup->get_keypair( ).
    lv_timewindowdefinition = lo_backup->get_preferredbackupwindow( ).
    lv_timewindowdefinition = lo_backup->get_preferredmaintenancewi00( ).
    lv_integer = lo_backup->get_s3datasize( ).
    lv_string = lo_backup->get_s3dataurl( ).
    lv_string = lo_backup->get_s3logurl( ).
    LOOP AT lo_backup->get_securitygroupids( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_servername = lo_backup->get_servername( ).
    lv_string = lo_backup->get_servicerolearn( ).
    lv_backupstatus = lo_backup->get_status( ).
    lv_string = lo_backup->get_statusdescription( ).
    LOOP AT lo_backup->get_subnetids( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_backup->get_toolsversion( ).
    lv_string = lo_backup->get_userarn( ).
  ENDIF.
ENDIF.

/AWS1/CL_OWC=>CREATEBACKUP()¶