Skip to content

/AWS1/CL_STG=>CREATETAPES()

About CreateTapes

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

Method Signature

IMPORTING

Required arguments:

iv_gatewayarn TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

iv_tapesizeinbytes TYPE /AWS1/STGTAPESIZE /AWS1/STGTAPESIZE

The size, in bytes, of the virtual tapes that you want to create.

The size must be aligned by gigabyte (102410241024 bytes).

iv_clienttoken TYPE /AWS1/STGCLIENTTOKEN /AWS1/STGCLIENTTOKEN

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Using the same ClientToken prevents creating the tape multiple times.

iv_numtapestocreate TYPE /AWS1/STGNUMTAPESTOCREATE /AWS1/STGNUMTAPESTOCREATE

The number of virtual tapes that you want to create.

iv_tapebarcodeprefix TYPE /AWS1/STGTAPEBARCODEPREFIX /AWS1/STGTAPEBARCODEPREFIX

A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

Optional arguments:

iv_kmsencrypted TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

iv_kmskey TYPE /AWS1/STGKMSKEY /AWS1/STGKMSKEY

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

iv_poolid TYPE /AWS1/STGPOOLID /AWS1/STGPOOLID

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

iv_worm TYPE /AWS1/STGBOOLEAN2 /AWS1/STGBOOLEAN2

Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

it_tags TYPE /AWS1/CL_STGTAG=>TT_TAGS TT_TAGS

A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

RETURNING

oo_output TYPE REF TO /aws1/cl_stgcreatetapesoutput /AWS1/CL_STGCREATETAPESOUTPUT

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_stg~createtapes(
  it_tags = VALUE /aws1/cl_stgtag=>tt_tags(
    (
      new /aws1/cl_stgtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_gatewayarn = |string|
  iv_kmsencrypted = ABAP_TRUE
  iv_kmskey = |string|
  iv_numtapestocreate = 123
  iv_poolid = |string|
  iv_tapebarcodeprefix = |string|
  iv_tapesizeinbytes = 123
  iv_worm = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_tapearns( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_tapearn = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To create a virtual tape

Creates one or more virtual tapes.

DATA(lo_result) = lo_client->/aws1/if_stg~createtapes(
  iv_clienttoken = |77777|
  iv_gatewayarn = |arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B|
  iv_numtapestocreate = 3
  iv_tapebarcodeprefix = |TEST|
  iv_tapesizeinbytes = 107374182400
).