Skip to content

/AWS1/IF_DSY=>CREATELOCATIONHDFS()

About CreateLocationHdfs

Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.

Before you begin, make sure that you understand how DataSync accesses HDFS clusters.

Method Signature

METHODS /AWS1/IF_DSY~CREATELOCATIONHDFS
  IMPORTING
    !IV_SUBDIRECTORY TYPE /AWS1/DSYHDFSSUBDIRECTORY OPTIONAL
    !IT_NAMENODES TYPE /AWS1/CL_DSYHDFSNAMENODE=>TT_HDFSNAMENODELIST OPTIONAL
    !IV_BLOCKSIZE TYPE /AWS1/DSYHDFSBLOCKSIZE OPTIONAL
    !IV_REPLICATIONFACTOR TYPE /AWS1/DSYHDFSREPLICATIONFACTOR OPTIONAL
    !IV_KMSKEYPROVIDERURI TYPE /AWS1/DSYKMSKEYPROVIDERURI OPTIONAL
    !IO_QOPCONFIGURATION TYPE REF TO /AWS1/CL_DSYQOPCONFIGURATION OPTIONAL
    !IV_AUTHENTICATIONTYPE TYPE /AWS1/DSYHDFSAUTHNTCTNTYPE OPTIONAL
    !IV_SIMPLEUSER TYPE /AWS1/DSYHDFSUSER OPTIONAL
    !IV_KERBEROSPRINCIPAL TYPE /AWS1/DSYKERBEROSPRINCIPAL OPTIONAL
    !IV_KERBEROSKEYTAB TYPE /AWS1/DSYKERBEROSKEYTABFILE OPTIONAL
    !IV_KERBEROSKRB5CONF TYPE /AWS1/DSYKERBEROSKRB5CONFFILE OPTIONAL
    !IT_AGENTARNS TYPE /AWS1/CL_DSYAGENTARNLIST_W=>TT_AGENTARNLIST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST 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_dsycreatelochdfsrsp
  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:

it_namenodes TYPE /AWS1/CL_DSYHDFSNAMENODE=>TT_HDFSNAMENODELIST TT_HDFSNAMENODELIST

The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.

iv_authenticationtype TYPE /AWS1/DSYHDFSAUTHNTCTNTYPE /AWS1/DSYHDFSAUTHNTCTNTYPE

The type of authentication used to determine the identity of the user.

it_agentarns TYPE /AWS1/CL_DSYAGENTARNLIST_W=>TT_AGENTARNLIST TT_AGENTARNLIST

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.

Optional arguments:

iv_subdirectory TYPE /AWS1/DSYHDFSSUBDIRECTORY /AWS1/DSYHDFSSUBDIRECTORY

A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.

iv_blocksize TYPE /AWS1/DSYHDFSBLOCKSIZE /AWS1/DSYHDFSBLOCKSIZE

The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).

iv_replicationfactor TYPE /AWS1/DSYHDFSREPLICATIONFACTOR /AWS1/DSYHDFSREPLICATIONFACTOR

The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.

iv_kmskeyprovideruri TYPE /AWS1/DSYKMSKEYPROVIDERURI /AWS1/DSYKMSKEYPROVIDERURI

The URI of the HDFS cluster's Key Management Server (KMS).

io_qopconfiguration TYPE REF TO /AWS1/CL_DSYQOPCONFIGURATION /AWS1/CL_DSYQOPCONFIGURATION

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If QopConfiguration isn't specified, RpcProtection and DataTransferProtection default to PRIVACY. If you set RpcProtection or DataTransferProtection, the other parameter assumes the same value.

iv_simpleuser TYPE /AWS1/DSYHDFSUSER /AWS1/DSYHDFSUSER

The user name used to identify the client on the host operating system.

If SIMPLE is specified for AuthenticationType, this parameter is required.

iv_kerberosprincipal TYPE /AWS1/DSYKERBEROSPRINCIPAL /AWS1/DSYKERBEROSPRINCIPAL

The Kerberos principal with access to the files and folders on the HDFS cluster.

If KERBEROS is specified for AuthenticationType, this parameter is required.

iv_kerberoskeytab TYPE /AWS1/DSYKERBEROSKEYTABFILE /AWS1/DSYKERBEROSKEYTABFILE

The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address.

If KERBEROS is specified for AuthenticationType, this parameter is required.

iv_kerberoskrb5conf TYPE /AWS1/DSYKERBEROSKRB5CONFFILE /AWS1/DSYKERBEROSKRB5CONFFILE

The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.

If KERBEROS is specified for AuthenticationType, this parameter is required.

it_tags TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST TT_INPUTTAGLIST

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

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

Specifies configuration information for a DataSync-managed secret, which includes the Kerberos keytab that DataSync uses to access a specific Hadoop Distributed File System (HDFS) storage location, with a customer-managed KMS key.

When you include this parameter as part of a CreateLocationHdfs request, you provide only the KMS key ARN. DataSync uses this KMS key together with the KerberosKeytab you specify for to create a DataSync-managed secret to store the location access credentials.

Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

You can use either CmkSecretConfig (with KerberosKeytab) or CustomSecretConfig (without KerberosKeytab) to provide credentials for a CreateLocationHdfs request. Do not provide both parameters for the same request.

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

Specifies configuration information for a customer-managed Secrets Manager secret where the Kerberos keytab for the HDFS storage location is stored in binary, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

You can use either CmkSecretConfig (with KerberosKeytab) or CustomSecretConfig (without KerberosKeytab) to provide credentials for a CreateLocationHdfs request. Do not provide both parameters for the same request.

RETURNING

oo_output TYPE REF TO /aws1/cl_dsycreatelochdfsrsp /AWS1/CL_DSYCREATELOCHDFSRSP

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->createlocationhdfs(
  io_cmksecretconfig = new /aws1/cl_dsycmksecretconfig(
    iv_kmskeyarn = |string|
    iv_secretarn = |string|
  )
  io_customsecretconfig = new /aws1/cl_dsycustomsecretconfig(
    iv_secretaccessrolearn = |string|
    iv_secretarn = |string|
  )
  io_qopconfiguration = new /aws1/cl_dsyqopconfiguration(
    iv_datatransferprotection = |string|
    iv_rpcprotection = |string|
  )
  it_agentarns = VALUE /aws1/cl_dsyagentarnlist_w=>tt_agentarnlist(
    ( new /aws1/cl_dsyagentarnlist_w( |string| ) )
  )
  it_namenodes = VALUE /aws1/cl_dsyhdfsnamenode=>tt_hdfsnamenodelist(
    (
      new /aws1/cl_dsyhdfsnamenode(
        iv_hostname = |string|
        iv_port = 123
      )
    )
  )
  it_tags = VALUE /aws1/cl_dsytaglistentry=>tt_inputtaglist(
    (
      new /aws1/cl_dsytaglistentry(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_authenticationtype = |string|
  iv_blocksize = 123
  iv_kerberoskeytab = '5347567362473873563239796247513D'
  iv_kerberoskrb5conf = '5347567362473873563239796247513D'
  iv_kerberosprincipal = |string|
  iv_kmskeyprovideruri = |string|
  iv_replicationfactor = 123
  iv_simpleuser = |string|
  iv_subdirectory = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_locationarn = lo_result->get_locationarn( ).
ENDIF.