Skip to main content

data_repository_association

Gets an individual data_repository_association resource

Overview

Namedata_repository_association
TypeResource
Descriptiondata_repository_association
Idawscc.fsx.data_repository_association

Fields

NameDatatypeDescription
association_idstring
resource_arnstring
file_system_idstringThe ID of the file system on which the data repository association is configured.
file_system_pathstringA path on the Amazon FSx for Lustre file system that points to a high-level directory (such as ``/ns1/``) or subdirectory (such as ``/ns1/subdir/``) that will be mapped 1-1 with ``DataRepositoryPath``. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path ``/ns1/``, then you cannot link another data repository with file system path ``/ns1/ns2``.<br/> This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.<br/> If you specify only a forward slash (``/``) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
data_repository_pathstringThe path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format ``s3://myBucket/myPrefix/``. This path specifies where in the S3 data repository files will be imported from or exported to.
batch_import_meta_data_on_createbooleanA boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to ``true``.
imported_file_chunk_sizeintegerFor files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.<br/> The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
s3objectThe configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
tagsarrayAn array of key-value pairs to apply to this resource.<br/> For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
association_id,
resource_arn,
file_system_id,
file_system_path,
data_repository_path,
batch_import_meta_data_on_create,
imported_file_chunk_size,
s3,
tags
FROM awscc.fsx.data_repository_association
WHERE data__Identifier = '<AssociationId>';

Permissions

To operate on the data_repository_association resource, the following permissions are required:

Read

fsx:DescribeDataRepositoryAssociations

Update

fsx:DescribeDataRepositoryAssociations,
fsx:UpdateDataRepositoryAssociation,
fsx:TagResource,
fsx:UntagResource,
s3:ListBucket,
s3:GetBucketPolicy,
s3:PutBucketPolicy,
iam:CreateServiceLinkedRole,
iam:PutRolePolicy

Delete

fsx:DescribeDataRepositoryAssociations,
fsx:DeleteDataRepositoryAssociation