software.amazon.awscdk.services.fsx

Class CfnDataRepositoryAssociationProps.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.CfnDataRepositoryAssociationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataRepositoryAssociationProps>

Enclosing interface:

CfnDataRepositoryAssociationProps

@Stability(value=Stable)
public static final class CfnDataRepositoryAssociationProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataRepositoryAssociationProps>

A builder for CfnDataRepositoryAssociationProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDataRepositoryAssociationProps.Builder	batchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate) Sets the value of CfnDataRepositoryAssociationProps.getBatchImportMetaDataOnCreate()
CfnDataRepositoryAssociationProps.Builder	batchImportMetaDataOnCreate(IResolvable batchImportMetaDataOnCreate) Sets the value of CfnDataRepositoryAssociationProps.getBatchImportMetaDataOnCreate()
CfnDataRepositoryAssociationProps	build() Builds the configured instance.
CfnDataRepositoryAssociationProps.Builder	dataRepositoryPath(String dataRepositoryPath) Sets the value of CfnDataRepositoryAssociationProps.getDataRepositoryPath()
CfnDataRepositoryAssociationProps.Builder	fileSystemId(String fileSystemId) Sets the value of CfnDataRepositoryAssociationProps.getFileSystemId()
CfnDataRepositoryAssociationProps.Builder	fileSystemPath(String fileSystemPath) Sets the value of CfnDataRepositoryAssociationProps.getFileSystemPath()
CfnDataRepositoryAssociationProps.Builder	importedFileChunkSize(Number importedFileChunkSize) Sets the value of CfnDataRepositoryAssociationProps.getImportedFileChunkSize()
CfnDataRepositoryAssociationProps.Builder	s3(CfnDataRepositoryAssociation.S3Property s3) Sets the value of CfnDataRepositoryAssociationProps.getS3()
CfnDataRepositoryAssociationProps.Builder	s3(IResolvable s3) Sets the value of CfnDataRepositoryAssociationProps.getS3()
CfnDataRepositoryAssociationProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnDataRepositoryAssociationProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

dataRepositoryPath

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder dataRepositoryPath(String dataRepositoryPath)

Sets the value of CfnDataRepositoryAssociationProps.getDataRepositoryPath()

Parameters:

dataRepositoryPath - The path to the data repository that will be linked to the cache or file system. This parameter is required.

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

this

fileSystemId

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder fileSystemId(String fileSystemId)

Sets the value of CfnDataRepositoryAssociationProps.getFileSystemId()

Parameters:

fileSystemId - `AWS::FSx::DataRepositoryAssociation.FileSystemId`. This parameter is required.

Returns:

this

fileSystemPath

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder fileSystemPath(String fileSystemPath)

Sets the value of CfnDataRepositoryAssociationProps.getFileSystemPath()

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` . This parameter is required. 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:

this

batchImportMetaDataOnCreate

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder batchImportMetaDataOnCreate(Boolean batchImportMetaDataOnCreate)

Sets the value of CfnDataRepositoryAssociationProps.getBatchImportMetaDataOnCreate()

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:

this

batchImportMetaDataOnCreate

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder batchImportMetaDataOnCreate(IResolvable batchImportMetaDataOnCreate)

Sets the value of CfnDataRepositoryAssociationProps.getBatchImportMetaDataOnCreate()

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:

this

importedFileChunkSize

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder importedFileChunkSize(Number importedFileChunkSize)

Sets the value of CfnDataRepositoryAssociationProps.getImportedFileChunkSize()

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:

this

s3

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder s3(IResolvable s3)

Sets the value of CfnDataRepositoryAssociationProps.getS3()

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:

this

s3

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder s3(CfnDataRepositoryAssociation.S3Property s3)

Sets the value of CfnDataRepositoryAssociationProps.getS3()

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:

this

tags

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDataRepositoryAssociationProps.getTags()

Parameters:

tags - `AWS::FSx::DataRepositoryAssociation.Tags`.

Returns:

this

build

@Stability(value=Stable)
public CfnDataRepositoryAssociationProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataRepositoryAssociationProps>

Returns:

a new instance of CfnDataRepositoryAssociationProps

Throws:

NullPointerException - if any required attribute was not provided