Skip to content

/AWS1/IF_DSY=>UPDATELOCATIONOBJECTSTORAGE()

About UpdateLocationObjectStorage

Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with an object storage system.

Method Signature

METHODS /AWS1/IF_DSY~UPDATELOCATIONOBJECTSTORAGE
  IMPORTING
    !IV_LOCATIONARN TYPE /AWS1/DSYLOCATIONARN OPTIONAL
    !IV_SERVERPORT TYPE /AWS1/DSYOBJECTSTRGSERVERPORT OPTIONAL
    !IV_SERVERPROTOCOL TYPE /AWS1/DSYOBJSTRGSERVERPROTOCOL OPTIONAL
    !IV_SUBDIRECTORY TYPE /AWS1/DSYS3SUBDIRECTORY OPTIONAL
    !IV_SERVERHOSTNAME TYPE /AWS1/DSYSERVERHOSTNAME OPTIONAL
    !IV_ACCESSKEY TYPE /AWS1/DSYOBJECTSTRGACCESSKEY OPTIONAL
    !IV_SECRETKEY TYPE /AWS1/DSYOBJECTSTRGSECRETKEY OPTIONAL
    !IT_AGENTARNS TYPE /AWS1/CL_DSYAGENTARNLIST_W=>TT_AGENTARNLIST OPTIONAL
    !IV_SERVERCERTIFICATE TYPE /AWS1/DSYOBJECTSTORAGECERT OPTIONAL
    !IO_CMKSECRETCONFIG TYPE REF TO /AWS1/CL_DSYCMKSECRETCONFIG OPTIONAL
    !IO_CUSTOMSECRETCONFIG TYPE REF TO /AWS1/CL_DSYCUSTOMSECRETCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsyupdlocobjstrgrsp
  RAISING
    /AWS1/CX_DSYINTERNALEXCEPTION
    /AWS1/CX_DSYINVALIDREQUESTEX
    /AWS1/CX_DSYCLIENTEXC
    /AWS1/CX_DSYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_locationarn TYPE /AWS1/DSYLOCATIONARN /AWS1/DSYLOCATIONARN

Specifies the ARN of the object storage system location that you're updating.

Optional arguments:

iv_serverport TYPE /AWS1/DSYOBJECTSTRGSERVERPORT /AWS1/DSYOBJECTSTRGSERVERPORT

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

iv_serverprotocol TYPE /AWS1/DSYOBJSTRGSERVERPROTOCOL /AWS1/DSYOBJSTRGSERVERPROTOCOL

Specifies the protocol that your object storage server uses to communicate.

iv_subdirectory TYPE /AWS1/DSYS3SUBDIRECTORY /AWS1/DSYS3SUBDIRECTORY

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

iv_serverhostname TYPE /AWS1/DSYSERVERHOSTNAME /AWS1/DSYSERVERHOSTNAME

Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.

iv_accesskey TYPE /AWS1/DSYOBJECTSTRGACCESSKEY /AWS1/DSYOBJECTSTRGACCESSKEY

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

iv_secretkey TYPE /AWS1/DSYOBJECTSTRGSECRETKEY /AWS1/DSYOBJECTSTRGSECRETKEY

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

If you provide a secret using SecretKey, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's Secrets Manager secret.

it_agentarns TYPE /AWS1/CL_DSYAGENTARNLIST_W=>TT_AGENTARNLIST TT_AGENTARNLIST

(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

You cannot add or remove agents from a storage location after you initially create it.

iv_servercertificate TYPE /AWS1/DSYOBJECTSTORAGECERT /AWS1/DSYOBJECTSTORAGECERT

Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

  • The object storage system's certificate

  • All intermediate certificates (if there are any)

  • The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

io_cmksecretconfig TYPE REF TO /AWS1/CL_DSYCMKSECRETCONFIG /AWS1/CL_DSYCMKSECRETCONFIG

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

io_customsecretconfig TYPE REF TO /AWS1/CL_DSYCUSTOMSECRETCONFIG /AWS1/CL_DSYCUSTOMSECRETCONFIG

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

RETURNING

oo_output TYPE REF TO /aws1/cl_dsyupdlocobjstrgrsp /AWS1/CL_DSYUPDLOCOBJSTRGRSP

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->updatelocationobjectstorage(
  io_cmksecretconfig = new /aws1/cl_dsycmksecretconfig(
    iv_kmskeyarn = |string|
    iv_secretarn = |string|
  )
  io_customsecretconfig = new /aws1/cl_dsycustomsecretconfig(
    iv_secretaccessrolearn = |string|
    iv_secretarn = |string|
  )
  it_agentarns = VALUE /aws1/cl_dsyagentarnlist_w=>tt_agentarnlist(
    ( new /aws1/cl_dsyagentarnlist_w( |string| ) )
  )
  iv_accesskey = |string|
  iv_locationarn = |string|
  iv_secretkey = |string|
  iv_servercertificate = '5347567362473873563239796247513D'
  iv_serverhostname = |string|
  iv_serverport = 123
  iv_serverprotocol = |string|
  iv_subdirectory = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.