software.amazon.awssdk.services.fsx.model

Interface FileCacheDataRepositoryAssociation.Builder

All Superinterfaces:

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

Enclosing class:

FileCacheDataRepositoryAssociation

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

Method Summary

Modifier and Type	Method and Description
FileCacheDataRepositoryAssociation.Builder	dataRepositoryPath(String dataRepositoryPath) The path to the S3 or NFS data repository that links to the cache.
FileCacheDataRepositoryAssociation.Builder	dataRepositorySubdirectories(Collection<String> dataRepositorySubdirectories) A list of NFS Exports that will be linked with this data repository association.
FileCacheDataRepositoryAssociation.Builder	dataRepositorySubdirectories(String... dataRepositorySubdirectories) A list of NFS Exports that will be linked with this data repository association.
FileCacheDataRepositoryAssociation.Builder	fileCachePath(String fileCachePath) A path on the 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.
default FileCacheDataRepositoryAssociation.Builder	nfs(Consumer<FileCacheNFSConfiguration.Builder> nfs) The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.
FileCacheDataRepositoryAssociation.Builder	nfs(FileCacheNFSConfiguration nfs) The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

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

fileCachePath

FileCacheDataRepositoryAssociation.Builder fileCachePath(String fileCachePath)

A path on the 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 name 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 where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other 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 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 name 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 where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other 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.

dataRepositoryPath

FileCacheDataRepositoryAssociation.Builder dataRepositoryPath(String dataRepositoryPath)

The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:

• The path can be an NFS data repository that links 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.

• The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

Parameters:

dataRepositoryPath - The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:

• The path can be an NFS data repository that links 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.

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

dataRepositorySubdirectories

FileCacheDataRepositoryAssociation.Builder dataRepositorySubdirectories(Collection<String> dataRepositorySubdirectories)

A list of NFS Exports that will be linked with this data repository association. 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 - A list of NFS Exports that will be linked with this data repository association. 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

FileCacheDataRepositoryAssociation.Builder dataRepositorySubdirectories(String... dataRepositorySubdirectories)

A list of NFS Exports that will be linked with this data repository association. 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 - A list of NFS Exports that will be linked with this data repository association. 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

FileCacheDataRepositoryAssociation.Builder nfs(FileCacheNFSConfiguration nfs)

The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

Parameters:

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

Returns:

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

nfs

default FileCacheDataRepositoryAssociation.Builder nfs(Consumer<FileCacheNFSConfiguration.Builder> nfs)

The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

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

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

Parameters:

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

Returns:

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

See Also:

nfs(FileCacheNFSConfiguration)