Skip to content

/AWS1/IF_BUP=>CREATEBACKUPACCESSPOINT()

About CreateBackupAccessPoint

Creates a backup access point for an Amazon S3 recovery point. A backup access point provides on-demand, read-only access to the backup data in a recovery point through an Amazon S3 access point, without initiating a restore.

While a backup access point is active for a recovery point, Backup pauses lifecycle transitions and blocks deletion of that recovery point.

Method Signature

METHODS /AWS1/IF_BUP~CREATEBACKUPACCESSPOINT
  IMPORTING
    !IT_ACCESSPOINTMETADATA TYPE /AWS1/CL_BUPACCPOINTMETMAP_W=>TT_ACCESSPOINTMETADATAMAP OPTIONAL
    !IV_ACCESSPOINTPOLICY TYPE /AWS1/BUPACCESSPOINTPOLICY OPTIONAL
    !IV_NAME TYPE /AWS1/BUPACCESSPOINTNAME OPTIONAL
    !IV_RECOVERYPOINTARN TYPE /AWS1/BUPRECOVERYPOINTARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_BUPTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bupcrebkupaccpointrsp
  RAISING
    /AWS1/CX_BUPALREADYEXISTSEX
    /AWS1/CX_BUPCONFLICTEXCEPTION
    /AWS1/CX_BUPINVPARAMVALUEEX
    /AWS1/CX_BUPINVALIDREQUESTEX
    /AWS1/CX_BUPLIMITEXCEEDEDEX
    /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_name TYPE /AWS1/BUPACCESSPOINTNAME /AWS1/BUPACCESSPOINTNAME

The name of the backup access point. This name is shared with the Amazon S3 access point namespace. It must be unique within your account and Region and cannot conflict with an existing Amazon S3 access point. For more information about access point naming, see Access points naming rules, restrictions, and limitations in the Amazon S3 User Guide.

iv_recoverypointarn TYPE /AWS1/BUPRECOVERYPOINTARN /AWS1/BUPRECOVERYPOINTARN

The Amazon Resource Name (ARN) of the recovery point for which to create the backup access point. The recovery point must be an Amazon S3 recovery point in the AVAILABLE, STOPPED, or COMPLETED state.

Optional arguments:

it_accesspointmetadata TYPE /AWS1/CL_BUPACCPOINTMETMAP_W=>TT_ACCESSPOINTMETADATAMAP TT_ACCESSPOINTMETADATAMAP

Metadata for the backup access point. For continuous (point-in-time) recovery points, you must include an AccessPointInTime timestamp (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time. You can specify any time within the continuous backup's retention period, up to the latest restorable time. For snapshot recovery points, do not include AccessPointInTime.

iv_accesspointpolicy TYPE /AWS1/BUPACCESSPOINTPOLICY /AWS1/BUPACCESSPOINTPOLICY

An optional resource-based policy, in JSON format, to apply to the underlying Amazon S3 access point. The policy controls how backup data can be accessed through the access point. If you do not specify a policy, access is governed by the caller's IAM permissions. For more information, see Configuring IAM policies for using access points in the Amazon S3 User Guide.

it_tags TYPE /AWS1/CL_BUPTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags to assign to the backup access point.

RETURNING

oo_output TYPE REF TO /aws1/cl_bupcrebkupaccpointrsp /AWS1/CL_BUPCREBKUPACCPOINTRSP

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->createbackupaccesspoint(
  it_accesspointmetadata = VALUE /aws1/cl_bupaccpointmetmap_w=>tt_accesspointmetadatamap(
    (
      VALUE /aws1/cl_bupaccpointmetmap_w=>ts_accesspointmetmap_maprow(
        key = |string|
        value = new /aws1/cl_bupaccpointmetmap_w( |string| )
      )
    )
  )
  it_tags = VALUE /aws1/cl_buptagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_buptagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_buptagmap_w( |string| )
      )
    )
  )
  iv_accesspointpolicy = |string|
  iv_name = |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_accesspointarn = lo_result->get_accesspointarn( ).
  lv_accesspointstatus = lo_result->get_status( ).
ENDIF.