Skip to content

/AWS1/IF_KYS=>RESTORETABLE()

About RestoreTable

Restores the table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.

Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.

In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.

You can also overwrite these settings during restore:

  • Read/write capacity mode

  • Provisioned throughput capacity units

  • Auto scaling settings

  • Point-in-time (PITR) settings

  • Tags

For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.

Note that the following settings are not restored, and you must configure them manually for the new table:

  • Identity and Access Management (IAM) policies

  • Amazon CloudWatch metrics and alarms

Method Signature

METHODS /AWS1/IF_KYS~RESTORETABLE
  IMPORTING
    !IV_SOURCEKEYSPACENAME TYPE /AWS1/KYSKEYSPACENAME OPTIONAL
    !IV_SOURCETABLENAME TYPE /AWS1/KYSTABLENAME OPTIONAL
    !IV_TARGETKEYSPACENAME TYPE /AWS1/KYSKEYSPACENAME OPTIONAL
    !IV_TARGETTABLENAME TYPE /AWS1/KYSTABLENAME OPTIONAL
    !IV_RESTORETIMESTAMP TYPE /AWS1/KYSTIMESTAMP OPTIONAL
    !IO_CAPACITYSPECOVERRIDE TYPE REF TO /AWS1/CL_KYSCAPACITYSPEC OPTIONAL
    !IO_ENCRYPTIONSPECOVERRIDE TYPE REF TO /AWS1/CL_KYSENCRYPTIONSPEC OPTIONAL
    !IO_POINTINTIMERECOVERRIDE TYPE REF TO /AWS1/CL_KYSPOINTINTIMEREC OPTIONAL
    !IT_TAGSOVERRIDE TYPE /AWS1/CL_KYSTAG=>TT_TAGLIST OPTIONAL
    !IO_AUTOSCALINGSPECIFICATION TYPE REF TO /AWS1/CL_KYSAUTOSCALINGSPEC OPTIONAL
    !IT_REPLICASPECIFICATIONS TYPE /AWS1/CL_KYSREPLICASPEC=>TT_REPLICASPECIFICATIONLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kysrestoretablersp
  RAISING
    /AWS1/CX_KYSACCESSDENIEDEX
    /AWS1/CX_KYSCONFLICTEXCEPTION
    /AWS1/CX_KYSINTERNALSERVEREX
    /AWS1/CX_KYSRESOURCENOTFOUNDEX
    /AWS1/CX_KYSSERVICEQUOTAEXCDEX
    /AWS1/CX_KYSVALIDATIONEX
    /AWS1/CX_KYSCLIENTEXC
    /AWS1/CX_KYSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_sourcekeyspacename TYPE /AWS1/KYSKEYSPACENAME /AWS1/KYSKEYSPACENAME

The keyspace name of the source table.

iv_sourcetablename TYPE /AWS1/KYSTABLENAME /AWS1/KYSTABLENAME

The name of the source table.

iv_targetkeyspacename TYPE /AWS1/KYSKEYSPACENAME /AWS1/KYSKEYSPACENAME

The name of the target keyspace.

iv_targettablename TYPE /AWS1/KYSTABLENAME /AWS1/KYSTABLENAME

The name of the target table.

Optional arguments:

iv_restoretimestamp TYPE /AWS1/KYSTIMESTAMP /AWS1/KYSTIMESTAMP

The restore timestamp in ISO 8601 format.

io_capacityspecoverride TYPE REF TO /AWS1/CL_KYSCAPACITYSPEC /AWS1/CL_KYSCAPACITYSPEC

Specifies the read/write throughput capacity mode for the target table. The options are:

  • throughputMode:PAY_PER_REQUEST

  • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

io_encryptionspecoverride TYPE REF TO /AWS1/CL_KYSENCRYPTIONSPEC /AWS1/CL_KYSENCRYPTIONSPEC

Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):

  • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

  • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

io_pointintimerecoverride TYPE REF TO /AWS1/CL_KYSPOINTINTIMEREC /AWS1/CL_KYSPOINTINTIMEREC

Specifies the pointInTimeRecovery settings for the target table. The options are:

  • status=ENABLED

  • status=DISABLED

If it's not specified, the default is status=DISABLED.

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

it_tagsoverride TYPE /AWS1/CL_KYSTAG=>TT_TAGLIST TT_TAGLIST

A list of key-value pair tags to be attached to the restored table.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

io_autoscalingspecification TYPE REF TO /AWS1/CL_KYSAUTOSCALINGSPEC /AWS1/CL_KYSAUTOSCALINGSPEC

The optional auto scaling settings for the restored table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

it_replicaspecifications TYPE /AWS1/CL_KYSREPLICASPEC=>TT_REPLICASPECIFICATIONLIST TT_REPLICASPECIFICATIONLIST

The optional Region specific settings of a multi-Regional table.

RETURNING

oo_output TYPE REF TO /aws1/cl_kysrestoretablersp /AWS1/CL_KYSRESTORETABLERSP

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->restoretable(
  io_autoscalingspecification = new /aws1/cl_kysautoscalingspec(
    io_readcapacityautoscaling = new /aws1/cl_kysautoscsettings(
      io_scalingpolicy = new /aws1/cl_kysautoscalingpolicy(
        io_targettrkscapolicyconf = new /aws1/cl_kystgttrkscaplyconf(
          iv_disablescalein = ABAP_TRUE
          iv_scaleincooldown = 123
          iv_scaleoutcooldown = 123
          iv_targetvalue = '0.1'
        )
      )
      iv_autoscalingdisabled = ABAP_TRUE
      iv_maximumunits = 123
      iv_minimumunits = 123
    )
    io_writecapacityautoscaling = new /aws1/cl_kysautoscsettings(
      io_scalingpolicy = new /aws1/cl_kysautoscalingpolicy(
        io_targettrkscapolicyconf = new /aws1/cl_kystgttrkscaplyconf(
          iv_disablescalein = ABAP_TRUE
          iv_scaleincooldown = 123
          iv_scaleoutcooldown = 123
          iv_targetvalue = '0.1'
        )
      )
      iv_autoscalingdisabled = ABAP_TRUE
      iv_maximumunits = 123
      iv_minimumunits = 123
    )
  )
  io_capacityspecoverride = new /aws1/cl_kyscapacityspec(
    iv_readcapacityunits = 123
    iv_throughputmode = |string|
    iv_writecapacityunits = 123
  )
  io_encryptionspecoverride = new /aws1/cl_kysencryptionspec(
    iv_kmskeyidentifier = |string|
    iv_type = |string|
  )
  io_pointintimerecoverride = new /aws1/cl_kyspointintimerec( |string| )
  it_replicaspecifications = VALUE /aws1/cl_kysreplicaspec=>tt_replicaspecificationlist(
    (
      new /aws1/cl_kysreplicaspec(
        io_readcapacityautoscaling = new /aws1/cl_kysautoscsettings(
          io_scalingpolicy = new /aws1/cl_kysautoscalingpolicy(
            io_targettrkscapolicyconf = new /aws1/cl_kystgttrkscaplyconf(
              iv_disablescalein = ABAP_TRUE
              iv_scaleincooldown = 123
              iv_scaleoutcooldown = 123
              iv_targetvalue = '0.1'
            )
          )
          iv_autoscalingdisabled = ABAP_TRUE
          iv_maximumunits = 123
          iv_minimumunits = 123
        )
        iv_readcapacityunits = 123
        iv_region = |string|
      )
    )
  )
  it_tagsoverride = VALUE /aws1/cl_kystag=>tt_taglist(
    (
      new /aws1/cl_kystag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_restoretimestamp = '20150101000000.0000000'
  iv_sourcekeyspacename = |string|
  iv_sourcetablename = |string|
  iv_targetkeyspacename = |string|
  iv_targettablename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_restoredtablearn( ).
ENDIF.