Class: Aws::FSx::Types::DataRepositoryAssociation

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3 bucket or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system. The data repository association configuration object is returned in the response of the following operations:

  • ‘CreateDataRepositoryAssociation`

  • ‘UpdateDataRepositoryAssociation`

  • ‘DescribeDataRepositoryAssociations`

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#association_id ⇒ String

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

Returns:

  • (String) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#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`.

<note markdown=“1”> ‘BatchImportMetaDataOnCreate` is not supported for data repositories linked to an Amazon File Cache resource.

</note>

Returns:

  • (Boolean) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

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

Returns:

  • (Time) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#data_repository_path ⇒ String

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://bucket-name/prefix/` (where `prefix` is optional).

  • For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format ‘s3://bucket-name/prefix/` (where `prefix` is optional).

Returns:

  • (String) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#data_repository_subdirectories ⇒ Array<String>

For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association. All the subdirectories must be on a single NFS file system. The Export paths are in the format ‘/exportpath1`. To use this parameter, you must configure `DataRepositoryPath` as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that `DataRepositorySubdirectories` is not supported for S3 data repositories.

Returns:

  • (Array<String>) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#failure_details ⇒ Types::DataRepositoryFailureDetails

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

Returns:



3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#file_cache_id ⇒ String

The globally unique ID of the Amazon File Cache resource.

Returns:

  • (String) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#file_cache_path ⇒ String

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.

<note markdown=“1”> 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.

</note>

Returns:

  • (String) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ String

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

Returns:

  • (String) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

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

<note markdown=“1”> 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.

</note>

Returns:

  • (String) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Integer) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle ⇒ String

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.

Returns:

  • (String) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#nfs ⇒ Types::NFSDataRepositoryConfiguration

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

Returns:



3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String) 


3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#s3 ⇒ Types::S3DataRepositoryConfiguration

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

Returns:



3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of ‘Tag` values, with a maximum of 50 elements.

Returns:



3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
 
# File 'lib/aws-sdk-fsx/types.rb', line 3726

class DataRepositoryAssociation < Struct.new(
  :association_id,
  :resource_arn,
  :file_system_id,
  :lifecycle,
  :failure_details,
  :file_system_path,
  :data_repository_path,
  :batch_import_meta_data_on_create,
  :imported_file_chunk_size,
  :s3,
  :tags,
  :creation_time,
  :file_cache_id,
  :file_cache_path,
  :data_repository_subdirectories,
  :nfs)
  SENSITIVE = []
  include Aws::Structure
end