Associate File System

storagegateway_associate_file_system

R Documentation

Associate an Amazon FSx file system with the FSx File Gateway¶

Description¶

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.

Usage¶

storagegateway_associate_file_system(UserName, Password, ClientToken,
  GatewayARN, LocationARN, Tags, AuditDestinationARN, CacheAttributes,
  EndpointNetworkConfiguration)

Arguments¶

UserName

[required] 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.

Password

[required] The password of the user credential.

ClientToken

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

GatewayARN

[required]

LocationARN

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

Tags

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

AuditDestinationARN

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

CacheAttributes

EndpointNetworkConfiguration

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.

Value¶

A list with the following syntax:

list(
  FileSystemAssociationARN = "string"
)

Request syntax¶

svc$associate_file_system(
  UserName = "string",
  Password = "string",
  ClientToken = "string",
  GatewayARN = "string",
  LocationARN = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  AuditDestinationARN = "string",
  CacheAttributes = list(
    CacheStaleTimeoutInSeconds = 123
  ),
  EndpointNetworkConfiguration = list(
    IpAddresses = list(
      "string"
    )
  )
)