software.amazon.awscdk.services.fsx

Interface CfnDataRepositoryAssociationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataRepositoryAssociationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:41.599Z")
 @Stability(value=Stable)
public interface CfnDataRepositoryAssociationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDataRepositoryAssociation`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.fsx.*;
 CfnDataRepositoryAssociationProps cfnDataRepositoryAssociationProps = CfnDataRepositoryAssociationProps.builder()
         .dataRepositoryPath("dataRepositoryPath")
         .fileSystemId("fileSystemId")
         .fileSystemPath("fileSystemPath")
         // the properties below are optional
         .batchImportMetaDataOnCreate(false)
         .importedFileChunkSize(123)
         .s3(S3Property.builder()
                 .autoExportPolicy(AutoExportPolicyProperty.builder()
                         .events(List.of("events"))
                         .build())
                 .autoImportPolicy(AutoImportPolicyProperty.builder()
                         .events(List.of("events"))
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataRepositoryAssociationProps.Builder A builder for CfnDataRepositoryAssociationProps
static class	CfnDataRepositoryAssociationProps.Jsii$Proxy An implementation for CfnDataRepositoryAssociationProps

Method Summary

Modifier and Type	Method and Description
static CfnDataRepositoryAssociationProps.Builder	builder()
default Object	getBatchImportMetaDataOnCreate() A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
String	getDataRepositoryPath() The path to the data repository that will be linked to the cache or file system.
String	getFileSystemId() `AWS::FSx::DataRepositoryAssociation.FileSystemId`.
String	getFileSystemPath() 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` .
default Number	getImportedFileChunkSize() 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.
default Object	getS3() The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.
default List<CfnTag>	getTags() `AWS::FSx::DataRepositoryAssociation.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDataRepositoryPath

@Stability(value=Stable)
 @NotNull
String getDataRepositoryPath()

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

getFileSystemId

@Stability(value=Stable)
 @NotNull
String getFileSystemId()

`AWS::FSx::DataRepositoryAssociation.FileSystemId`.

getFileSystemPath

@Stability(value=Stable)
 @NotNull
String getFileSystemPath()

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.

getBatchImportMetaDataOnCreate

@Stability(value=Stable)
 @Nullable
default Object getBatchImportMetaDataOnCreate()

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.

getImportedFileChunkSize

@Stability(value=Stable)
 @Nullable
default Number getImportedFileChunkSize()

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.

getS3

@Stability(value=Stable)
 @Nullable
default Object getS3()

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::FSx::DataRepositoryAssociation.Tags`.

builder

@Stability(value=Stable)
static CfnDataRepositoryAssociationProps.Builder builder()

Returns:

a CfnDataRepositoryAssociationProps.Builder of CfnDataRepositoryAssociationProps