Skip to content

aws.fsx.describe_data_repository_associations

Example SQL Queries

SELECT * FROM
aws.fsx.describe_data_repository_associations;

Description

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.

Table Definition

Column NameColumn Data Type
association_ids Input Column

IDs of the data repository associations whose descriptions you want to retrieve (String).

VARCHAR[]
Show child fields
association_ids[]
filters Input Column

A list of Filter elements.

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name for this filter.

filters[].values[]
max_results Input Column

The maximum number of resources to return in the response. This value must be an integer greater than zero.

BIGINT
next_token Input Column

(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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
associations

An array of one or more data repository association descriptions.

STRUCT(
"association_id" VARCHAR,
"resource_arn" VARCHAR,
"file_system_id" VARCHAR,
"lifecycle" VARCHAR,
"failure_details" STRUCT(
"message" VARCHAR
),
"file_system_path" VARCHAR,
"data_repository_path" VARCHAR,
"batch_import_meta_data_on_create" BOOLEAN,
"imported_file_chunk_size" BIGINT,
"s3" STRUCT(
"auto_import_policy" STRUCT(
"events" VARCHAR[]
),
"auto_export_policy" STRUCT(
"events" VARCHAR[]
)
),
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"creation_time" TIMESTAMP_S,
"file_cache_id" VARCHAR,
"file_cache_path" VARCHAR,
"data_repository_subdirectories" VARCHAR[],
"nfs" STRUCT(
"version" VARCHAR,
"dns_ips" VARCHAR[],
"auto_export_policy" STRUCT(
"events" VARCHAR[]
)
)
)[]
Show child fields
associations[]
Show child fields
associations[].association_id

The system-generated, unique ID of the data repository association.

associations[].batch_import_meta_data_on_create

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.

BatchImportMetaDataOnCreate is not supported for data repositories linked to an Amazon File Cache resource.

associations[].creation_time

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

associations[].data_repository_path

The path to the data repository that will be linked to the cache or file system.

  • For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:

    • If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.

    • If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.

  • For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

  • For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

associations[].data_repository_subdirectories[]
associations[].failure_details

Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

Show child fields
associations[].failure_details.message

A detailed error message.

associations[].file_cache_id

The globally unique ID of the Amazon File Cache resource.

associations[].file_cache_path

A path on the Amazon File Cache 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 path is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and no other data repository can be linked to the directory.

The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.

The cache path cannot be set to root (/) for an S3 DRA.

associations[].file_system_id

The globally unique ID of the file system, assigned by Amazon FSx.

associations[].file_system_path

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.

associations[].imported_file_chunk_size

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.

associations[].lifecycle

Describes the state of a data repository association. The lifecycle can have the following values:

  • CREATING - The data repository association between the file system or cache and the data repository is being created. The data repository is unavailable.

  • AVAILABLE - The data repository association is available for use.

  • MISCONFIGURED - The data repository association is misconfigured. Until the configuration is corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre).

  • UPDATING - The data repository association is undergoing a customer initiated update that might affect its availability.

  • DELETING - The data repository association is undergoing a customer initiated deletion.

  • FAILED - The data repository association is in a terminal state that cannot be recovered.

associations[].nfs

The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.

Show child fields
associations[].nfs.auto_export_policy

This parameter is not supported for Amazon File Cache.

Show child fields
associations[].nfs.auto_export_policy.events[]
associations[].nfs.dns_ips[]
associations[].nfs.version

The version of the NFS (Network File System) protocol of the NFS data repository. Currently, the only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.

associations[].resource_arn

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

associations[].s3

The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.

Show child fields
associations[].s3.auto_export_policy

Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket.

Show child fields
associations[].s3.auto_export_policy.events[]
associations[].s3.auto_import_policy

Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system.

Show child fields
associations[].s3.auto_import_policy.events[]
associations[].tags[]
Show child fields
associations[].tags[].key

A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

associations[].tags[].value

A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.