data_repository_associations

Creates, updates, deletes, gets or lists a data_repository_associations resource.

Overview

Name	`data_repository_associations`
Type	Resource
Id	`aws.fsx.data_repository_associations`

Fields

The following fields are returned by SELECT queries:

describe_data_repository_associations

Name	Datatype	Description
`associations`	`array`	An array of one or more data repository association descriptions.
`next_token`	`string`	(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off. (pattern: <code>^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_data_repository_associations`	`select`	`region`	Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type. You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
`create_data_repository_association`	`insert`	`region`, `FileSystemId`, `DataRepositoryPath`	Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type. Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket. CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.
`update_data_repository_association`	`update`	`region`, `AssociationId`	Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
`delete_data_repository_association`	`delete`	`region`	Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_data_repository_associations

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type. You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

SELECT
associations,
next_token
FROM aws.fsx.data_repository_associations
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_data_repository_association
Manifest

Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type. Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket. CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.

INSERT INTO aws.fsx.data_repository_associations (
FileSystemId,
FileSystemPath,
DataRepositoryPath,
BatchImportMetaDataOnCreate,
ImportedFileChunkSize,
S3,
ClientRequestToken,
Tags,
region
)
SELECT 
'{{ FileSystemId }}' /* required */,
'{{ FileSystemPath }}',
'{{ DataRepositoryPath }}' /* required */,
{{ BatchImportMetaDataOnCreate }},
{{ ImportedFileChunkSize }},
'{{ S3 }}',
'{{ ClientRequestToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
association
;

# Description fields are for documentation purposes
- name: data_repository_associations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_repository_associations resource.
  - name: FileSystemId
    value: "{{ FileSystemId }}"
    description: |
      The globally unique ID of the file system, assigned by Amazon FSx.
  - name: FileSystemPath
    value: "{{ FileSystemPath }}"
    description: |
      A path on the 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. 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. 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.
  - name: DataRepositoryPath
    value: "{{ DataRepositoryPath }}"
    description: |
      The 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://bucket-name/prefix/ (where prefix is optional). This path specifies where in the S3 data repository files will be imported from or exported to.
  - name: BatchImportMetaDataOnCreate
    value: {{ BatchImportMetaDataOnCreate }}
    description: |
      Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.
  - name: ImportedFileChunkSize
    value: {{ ImportedFileChunkSize }}
    description: |
      For 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. 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.
  - name: S3
    description: |
      The 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.
    value:
      AutoImportPolicy:
        Events:
          - "{{ Events }}"
      AutoExportPolicy:
        Events:
          - "{{ Events }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
  - name: Tags
    description: |
      A list of Tag values, with a maximum of 50 elements.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

`UPDATE` examples

update_data_repository_association

Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

UPDATE aws.fsx.data_repository_associations
SET 
AssociationId = '{{ AssociationId }}',
ClientRequestToken = '{{ ClientRequestToken }}',
ImportedFileChunkSize = {{ ImportedFileChunkSize }},
S3 = '{{ S3 }}'
WHERE 
region = '{{ region }}' --required
AND AssociationId = '{{ AssociationId }}' --required
RETURNING
association;

`DELETE` examples

delete_data_repository_association

Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

DELETE FROM aws.fsx.data_repository_associations
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​