UPDATERECOVERYPOINTINDEXSTGS()`¶

About UpdateRecoveryPointIndexSettings¶

This operation updates the settings of a recovery point index.

Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn

Method Signature¶

METHODS /AWS1/IF_BUP~UPDATERECOVERYPOINTINDEXSTGS
  IMPORTING
    !IV_BACKUPVAULTNAME TYPE /AWS1/BUPBACKUPVAULTNAME OPTIONAL
    !IV_RECOVERYPOINTARN TYPE /AWS1/BUPARN OPTIONAL
    !IV_IAMROLEARN TYPE /AWS1/BUPIAMROLEARN OPTIONAL
    !IV_INDEX TYPE /AWS1/BUPINDEX OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bupupdrecptidxstgsout
  RAISING
    /AWS1/CX_BUPINVPARAMVALUEEX
    /AWS1/CX_BUPINVALIDREQUESTEX
    /AWS1/CX_BUPMISSINGPARAMVALEX
    /AWS1/CX_BUPRESOURCENOTFOUNDEX
    /AWS1/CX_BUPSERVICEUNAVAILEX
    /AWS1/CX_BUPCLIENTEXC
    /AWS1/CX_BUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_backupvaultname` `TYPE /AWS1/BUPBACKUPVAULTNAME` `/AWS1/BUPBACKUPVAULTNAME`¶

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

Accepted characters include lowercase letters, numbers, and hyphens.

`iv_recoverypointarn` `TYPE /AWS1/BUPARN` `/AWS1/BUPARN`¶

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

`iv_index` `TYPE /AWS1/BUPINDEX` `/AWS1/BUPINDEX`¶

Index can have 1 of 2 possible values, either ENABLED or DISABLED.

To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

To delete a backup index, set value to DISABLED.

Optional arguments:¶

`iv_iamrolearn` `TYPE /AWS1/BUPIAMROLEARN` `/AWS1/BUPIAMROLEARN`¶

This specifies the IAM role ARN used for this operation.

For example, arn:aws:iam::123456789012:role/S3Access

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bupupdrecptidxstgsout` `/AWS1/CL_BUPUPDRECPTIDXSTGSOUT`¶

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->updaterecoverypointindexstgs(
  iv_backupvaultname = |string|
  iv_iamrolearn = |string|
  iv_index = |string|
  iv_recoverypointarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_backupvaultname = lo_result->get_backupvaultname( ).
  lv_arn = lo_result->get_recoverypointarn( ).
  lv_indexstatus = lo_result->get_indexstatus( ).
  lv_index = lo_result->get_index( ).
ENDIF.

/AWS1/IF_BUP=>UPDATERECOVERYPOINTINDEXSTGS()¶