Skip to content

/AWS1/IF_STG=>ASSOCIATEFILESYSTEM()

About AssociateFileSystem

Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.

Method Signature

METHODS /AWS1/IF_STG~ASSOCIATEFILESYSTEM
  IMPORTING
    !IV_USERNAME TYPE /AWS1/STGDOMAINUSERNAME OPTIONAL
    !IV_PASSWORD TYPE /AWS1/STGDOMAINUSERPASSWORD OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/STGCLIENTTOKEN OPTIONAL
    !IV_GATEWAYARN TYPE /AWS1/STGGATEWAYARN OPTIONAL
    !IV_LOCATIONARN TYPE /AWS1/STGFILESYSTEMLOCATIONARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_STGTAG=>TT_TAGS OPTIONAL
    !IV_AUDITDESTINATIONARN TYPE /AWS1/STGAUDITDESTINATIONARN OPTIONAL
    !IO_CACHEATTRIBUTES TYPE REF TO /AWS1/CL_STGCACHEATTRIBUTES OPTIONAL
    !IO_ENDPOINTNETWORKCONF TYPE REF TO /AWS1/CL_STGENDPTNETWORKCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_stgassocfilesystemout
  RAISING
    /AWS1/CX_STGINTERNALSERVERERR
    /AWS1/CX_STGINVALIDGWREQUESTEX
    /AWS1/CX_STGCLIENTEXC
    /AWS1/CX_STGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_username TYPE /AWS1/STGDOMAINUSERNAME /AWS1/STGDOMAINUSERNAME

The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

iv_password TYPE /AWS1/STGDOMAINUSERPASSWORD /AWS1/STGDOMAINUSERPASSWORD

The password of the user credential.

iv_clienttoken TYPE /AWS1/STGCLIENTTOKEN /AWS1/STGCLIENTTOKEN

A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

iv_gatewayarn TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN

GatewayARN

iv_locationarn TYPE /AWS1/STGFILESYSTEMLOCATIONARN /AWS1/STGFILESYSTEMLOCATIONARN

The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

Optional arguments:

it_tags TYPE /AWS1/CL_STGTAG=>TT_TAGS TT_TAGS

A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

iv_auditdestinationarn TYPE /AWS1/STGAUDITDESTINATIONARN /AWS1/STGAUDITDESTINATIONARN

The Amazon Resource Name (ARN) of the storage used for the audit logs.

io_cacheattributes TYPE REF TO /AWS1/CL_STGCACHEATTRIBUTES /AWS1/CL_STGCACHEATTRIBUTES

CacheAttributes

io_endpointnetworkconf TYPE REF TO /AWS1/CL_STGENDPTNETWORKCONF /AWS1/CL_STGENDPTNETWORKCONF

Specifies the network configuration information for the gateway associated with the Amazon FSx file system.

If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.

RETURNING

oo_output TYPE REF TO /aws1/cl_stgassocfilesystemout /AWS1/CL_STGASSOCFILESYSTEMOUT

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->associatefilesystem(
  io_cacheattributes = new /aws1/cl_stgcacheattributes( 123 )
  io_endpointnetworkconf = new /aws1/cl_stgendptnetworkconf(
    it_ipaddresses = VALUE /aws1/cl_stgipaddresslist_w=>tt_ipaddresslist(
      ( new /aws1/cl_stgipaddresslist_w( |string| ) )
    )
  )
  it_tags = VALUE /aws1/cl_stgtag=>tt_tags(
    (
      new /aws1/cl_stgtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_auditdestinationarn = |string|
  iv_clienttoken = |string|
  iv_gatewayarn = |string|
  iv_locationarn = |string|
  iv_password = |string|
  iv_username = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_filesystemassociationar = lo_result->get_filesystemassociationarn( ).
ENDIF.