software.amazon.awssdk.services.fsx.model

Interface DataRepositoryAssociation.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DataRepositoryAssociation.Builder,DataRepositoryAssociation>, SdkBuilder<DataRepositoryAssociation.Builder,DataRepositoryAssociation>, SdkPojo

Enclosing class:

DataRepositoryAssociation

public static interface DataRepositoryAssociation.Builder
extends SdkPojo, CopyableBuilder<DataRepositoryAssociation.Builder,DataRepositoryAssociation>

Method Summary

Modifier and Type	Method and Description
DataRepositoryAssociation.Builder	associationId(String associationId) The system-generated, unique ID of the data repository association.
DataRepositoryAssociation.Builder	batchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate) A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
DataRepositoryAssociation.Builder	creationTime(Instant creationTime) Sets the value of the CreationTime property for this object.
DataRepositoryAssociation.Builder	dataRepositoryPath(String dataRepositoryPath) The path to the data repository that will be linked to the cache or file system.
DataRepositoryAssociation.Builder	dataRepositorySubdirectories(Collection<String> dataRepositorySubdirectories) For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association.
DataRepositoryAssociation.Builder	dataRepositorySubdirectories(String... dataRepositorySubdirectories) For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association.
default DataRepositoryAssociation.Builder	failureDetails(Consumer<DataRepositoryFailureDetails.Builder> failureDetails) Sets the value of the FailureDetails property for this object.
DataRepositoryAssociation.Builder	failureDetails(DataRepositoryFailureDetails failureDetails) Sets the value of the FailureDetails property for this object.
DataRepositoryAssociation.Builder	fileCacheId(String fileCacheId) The globally unique ID of the Amazon File Cache resource.
DataRepositoryAssociation.Builder	fileCachePath(String fileCachePath) 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 .
DataRepositoryAssociation.Builder	fileSystemId(String fileSystemId) Sets the value of the FileSystemId property for this object.
DataRepositoryAssociation.Builder	fileSystemPath(String fileSystemPath) 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.
DataRepositoryAssociation.Builder	importedFileChunkSize(Integer importedFileChunkSize) 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.
DataRepositoryAssociation.Builder	lifecycle(DataRepositoryLifecycle lifecycle) Describes the state of a data repository association.
DataRepositoryAssociation.Builder	lifecycle(String lifecycle) Describes the state of a data repository association.
default DataRepositoryAssociation.Builder	nfs(Consumer<NFSDataRepositoryConfiguration.Builder> nfs) The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.
DataRepositoryAssociation.Builder	nfs(NFSDataRepositoryConfiguration nfs) The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.
DataRepositoryAssociation.Builder	resourceARN(String resourceARN) Sets the value of the ResourceARN property for this object.
default DataRepositoryAssociation.Builder	s3(Consumer<S3DataRepositoryConfiguration.Builder> s3) The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.
DataRepositoryAssociation.Builder	s3(S3DataRepositoryConfiguration s3) The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.
DataRepositoryAssociation.Builder	tags(Collection<Tag> tags) Sets the value of the Tags property for this object.
DataRepositoryAssociation.Builder	tags(Consumer<Tag.Builder>... tags) Sets the value of the Tags property for this object.
DataRepositoryAssociation.Builder	tags(Tag... tags) Sets the value of the Tags property for this object.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

associationId

DataRepositoryAssociation.Builder associationId(String associationId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceARN

DataRepositoryAssociation.Builder resourceARN(String resourceARN)

Sets the value of the ResourceARN property for this object.

Parameters:

resourceARN - The new value for the ResourceARN property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

fileSystemId

DataRepositoryAssociation.Builder fileSystemId(String fileSystemId)

Sets the value of the FileSystemId property for this object.

Parameters:

fileSystemId - The new value for the FileSystemId property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycle

DataRepositoryAssociation.Builder lifecycle(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataRepositoryLifecycle, DataRepositoryLifecycle

lifecycle

DataRepositoryAssociation.Builder lifecycle(DataRepositoryLifecycle 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataRepositoryLifecycle, DataRepositoryLifecycle

failureDetails

DataRepositoryAssociation.Builder failureDetails(DataRepositoryFailureDetails failureDetails)

Sets the value of the FailureDetails property for this object.

Parameters:

failureDetails - The new value for the FailureDetails property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureDetails

default DataRepositoryAssociation.Builder failureDetails(Consumer<DataRepositoryFailureDetails.Builder> failureDetails)

Sets the value of the FailureDetails property for this object. This is a convenience method that creates an instance of the DataRepositoryFailureDetails.Builder avoiding the need to create one manually via DataRepositoryFailureDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureDetails(DataRepositoryFailureDetails).

Parameters:

failureDetails - a consumer that will call methods on DataRepositoryFailureDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

failureDetails(DataRepositoryFailureDetails)

fileSystemPath

DataRepositoryAssociation.Builder fileSystemPath(String fileSystemPath)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dataRepositoryPath

DataRepositoryAssociation.Builder dataRepositoryPath(String dataRepositoryPath)

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

Parameters:

dataRepositoryPath - 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/.

Returns:

Returns a reference to this object so that method calls can be chained together.

batchImportMetaDataOnCreate

DataRepositoryAssociation.Builder batchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

importedFileChunkSize

DataRepositoryAssociation.Builder importedFileChunkSize(Integer importedFileChunkSize)

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.

Parameters:

importedFileChunkSize - 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:

Returns a reference to this object so that method calls can be chained together.

s3

DataRepositoryAssociation.Builder s3(S3DataRepositoryConfiguration s3)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

s3

default DataRepositoryAssociation.Builder s3(Consumer<S3DataRepositoryConfiguration.Builder> s3)

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

This is a convenience method that creates an instance of the S3DataRepositoryConfiguration.Builder avoiding the need to create one manually via S3DataRepositoryConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3(S3DataRepositoryConfiguration).

Parameters:

s3 - a consumer that will call methods on S3DataRepositoryConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

s3(S3DataRepositoryConfiguration)

tags

DataRepositoryAssociation.Builder tags(Collection<Tag> tags)

Sets the value of the Tags property for this object.

Parameters:

tags - The new value for the Tags property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

DataRepositoryAssociation.Builder tags(Tag... tags)

Sets the value of the Tags property for this object.

Parameters:

tags - The new value for the Tags property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

DataRepositoryAssociation.Builder tags(Consumer<Tag.Builder>... tags)

Sets the value of the Tags property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

creationTime

DataRepositoryAssociation.Builder creationTime(Instant creationTime)

Sets the value of the CreationTime property for this object.

Parameters:

creationTime - The new value for the CreationTime property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

fileCacheId

DataRepositoryAssociation.Builder fileCacheId(String fileCacheId)

The globally unique ID of the Amazon File Cache resource.

Parameters:

fileCacheId - The globally unique ID of the Amazon File Cache resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

fileCachePath

DataRepositoryAssociation.Builder fileCachePath(String fileCachePath)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dataRepositorySubdirectories

DataRepositoryAssociation.Builder dataRepositorySubdirectories(Collection<String> dataRepositorySubdirectories)

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.

Parameters:

dataRepositorySubdirectories - 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:

Returns a reference to this object so that method calls can be chained together.

dataRepositorySubdirectories

DataRepositoryAssociation.Builder dataRepositorySubdirectories(String... dataRepositorySubdirectories)

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.

Parameters:

dataRepositorySubdirectories - 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:

Returns a reference to this object so that method calls can be chained together.

nfs

DataRepositoryAssociation.Builder nfs(NFSDataRepositoryConfiguration nfs)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

nfs

default DataRepositoryAssociation.Builder nfs(Consumer<NFSDataRepositoryConfiguration.Builder> nfs)

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

This is a convenience method that creates an instance of the NFSDataRepositoryConfiguration.Builder avoiding the need to create one manually via NFSDataRepositoryConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nfs(NFSDataRepositoryConfiguration).

Parameters:

nfs - a consumer that will call methods on NFSDataRepositoryConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

nfs(NFSDataRepositoryConfiguration)