data_repository_associations

Creates, updates, deletes or gets a data_repository_association resource or lists data_repository_associations in a region

Overview

Name	`data_repository_associations`
Type	Resource
Description	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 newer 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.
Id	`awscc.fsx.data_repository_associations`

Fields

get (all properties)
list (identifiers only)

Name	Datatype	Description
`association_id`	`string`
`resource_arn`	`string`
`file_system_id`	`string`	The ID of the file system on which the data repository association is configured.
`file_system_path`	`string`	A 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`. 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.
`data_repository_path`	`string`	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://myBucket/myPrefix/`. This path specifies where in the S3 data repository files will be imported from or exported to.
`batch_import_meta_data_on_create`	`boolean`	A 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_size`	`integer`	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 or cache. 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.
▶`s3`	`object`	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.
▶`tags`	`array`	An array of key-value pairs to apply to this resource. For more information, see Tag.
`region`	`string`	AWS region.

Name	Datatype	Description
`association_id`	`string`
`region`	`string`	AWS region.

For more information, see AWS::FSx::DataRepositoryAssociation.

Methods

Name	Resource	Accessible by	Required Params
`create_resource`	`data_repository_associations`	`INSERT`	`FileSystemId, FileSystemPath, DataRepositoryPath, region`
`delete_resource`	`data_repository_associations`	`DELETE`	`Identifier, region`
`update_resource`	`data_repository_associations`	`UPDATE`	`Identifier, PatchDocument, region`
`list_resources`	`data_repository_associations_list_only`	`SELECT`	`region`
`get_resource`	`data_repository_associations`	`SELECT`	`Identifier, region`

`SELECT` examples

get (all properties)
list (identifiers only)

Gets all properties from an individual data_repository_association.

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_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ association_id }}';

Lists all data_repository_associations in a region.

SELECT
  region,
  association_id
FROM awscc.fsx.data_repository_associations_list_only
WHERE
  region = '{{ region }}';

`INSERT` example

Use the following StackQL query and manifest file to create a new data_repository_association resource, using stack-deploy.

Required Properties
All Properties
Manifest

/*+ create */
INSERT INTO awscc.fsx.data_repository_associations (
  FileSystemId,
  FileSystemPath,
  DataRepositoryPath,
  region
)
SELECT
  '{{ file_system_id }}',
  '{{ file_system_path }}',
  '{{ data_repository_path }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

/*+ create */
INSERT INTO awscc.fsx.data_repository_associations (
  FileSystemId,
  FileSystemPath,
  DataRepositoryPath,
  BatchImportMetaDataOnCreate,
  ImportedFileChunkSize,
  S3,
  Tags,
  region
)
SELECT
  '{{ file_system_id }}',
  '{{ file_system_path }}',
  '{{ data_repository_path }}',
  '{{ batch_import_meta_data_on_create }}',
  '{{ imported_file_chunk_size }}',
  '{{ s3 }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: data_repository_association
  props:
    - name: file_system_id
      value: '{{ file_system_id }}'
    - name: file_system_path
      value: '{{ file_system_path }}'
    - name: data_repository_path
      value: '{{ data_repository_path }}'
    - name: batch_import_meta_data_on_create
      value: '{{ batch_import_meta_data_on_create }}'
    - name: imported_file_chunk_size
      value: '{{ imported_file_chunk_size }}'
    - name: s3
      value:
        auto_import_policy:
          events:
            - '{{ events[0] }}'
        auto_export_policy:
          events: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

`UPDATE` example

Use the following StackQL query and manifest file to update a data_repository_association resource, using stack-deploy.

/*+ update */
UPDATE awscc.fsx.data_repository_associations
SET PatchDocument = string('{{ {
    "ImportedFileChunkSize": imported_file_chunk_size,
    "S3": s3,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ association_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

`DELETE` example

/*+ delete */
DELETE FROM awscc.fsx.data_repository_associations
WHERE
  Identifier = '{{ association_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
`ClientToken`	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
`RoleArn`	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
`TypeVersionId`	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create
Read
Update
Delete
List

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

fsx:DescribeDataRepositoryAssociations

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

fsx:DescribeDataRepositoryAssociations,
fsx:DeleteDataRepositoryAssociation

fsx:DescribeDataRepositoryAssociations

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​

Additional Parameters​

Permissions​