Skip to content

/AWS1/CL_NEP=>MODIFYDBCLUSTERSNAPSHOTATTR()

About ModifyDBClusterSnapshotAttribute

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other Amazon accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

Method Signature

IMPORTING

Required arguments:

iv_dbclustersnapshotid TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The identifier for the DB cluster snapshot to modify the attributes for.

iv_attributename TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

Optional arguments:

it_valuestoadd TYPE /AWS1/CL_NEPATTRVALUELIST_W=>TT_ATTRIBUTEVALUELIST TT_ATTRIBUTEVALUELIST

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts.

it_valuestoremove TYPE /AWS1/CL_NEPATTRVALUELIST_W=>TT_ATTRIBUTEVALUELIST TT_ATTRIBUTEVALUELIST

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account identifiers, or all to remove authorization for any Amazon account to copy or restore the DB cluster snapshot. If you specify all, an Amazon account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

RETURNING

oo_output TYPE REF TO /aws1/cl_nepmoddbclstsnapatt01 /AWS1/CL_NEPMODDBCLSTSNAPATT01

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_nep~modifydbclustersnapshotattr(
  it_valuestoadd = VALUE /aws1/cl_nepattrvaluelist_w=>tt_attributevaluelist(
    ( new /aws1/cl_nepattrvaluelist_w( |string| ) )
  )
  it_valuestoremove = VALUE /aws1/cl_nepattrvaluelist_w=>tt_attributevaluelist(
    ( new /aws1/cl_nepattrvaluelist_w( |string| ) )
  )
  iv_attributename = |string|
  iv_dbclustersnapshotid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_dbclustersnapshotattrib = lo_result->get_dbclustersnapattrsresult( ).
  IF lo_dbclustersnapshotattrib IS NOT INITIAL.
    lv_string = lo_dbclustersnapshotattrib->get_dbclustersnapshotid( ).
    LOOP AT lo_dbclustersnapshotattrib->get_dbclustersnapshotattrs( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_attributename( ).
        LOOP AT lo_row_1->get_attributevalues( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_string = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.