StorageGateway / Client / associate_file_system

associate_file_system

StorageGateway.Client.associate_file_system(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.associate_file_system(
    UserName='string',
    Password='string',
    ClientToken='string',
    GatewayARN='string',
    LocationARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AuditDestinationARN='string',
    CacheAttributes={
        'CacheStaleTimeoutInSeconds': 123
    },
    EndpointNetworkConfiguration={
        'IpAddresses': [
            'string',
        ]
    }
)

Parameters:

• UserName (string) –

  [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 (string) –

  [REQUIRED]

  The password of the user credential.

• ClientToken (string) –

  [REQUIRED]

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

• GatewayARN (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• LocationARN (string) –

  [REQUIRED]

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

• Tags (list) –

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

  • (dict) –

    A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

    • Key (string) – [REQUIRED]

      Tag key. The key can’t start with aws:.

    • Value (string) – [REQUIRED]

      Value of the tag key.

• AuditDestinationARN (string) – The Amazon Resource Name (ARN) of the storage used for the audit logs.

• CacheAttributes (dict) –

  The refresh cache information for the file share or FSx file systems.

  • CacheStaleTimeoutInSeconds (integer) –

    Refreshes a file share’s cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory’s contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

    Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

• EndpointNetworkConfiguration (dict) –

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

  Note

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

  • IpAddresses (list) –

    A list of gateway IP addresses on which the associated Amazon FSx file system is available.

    Note

    If multiple file systems are associated with this gateway, this field is required.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'FileSystemAssociationARN': 'string'
}

Response Structure

• (dict) –

  • FileSystemAssociationARN (string) –

    The ARN of the newly created file system association.

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException

• StorageGateway.Client.exceptions.InternalServerError