Package 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.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.214Z")
@Stability(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Amazon S3 data repository that will be linked to the file system.
String	getFileSystemId()	The ID of the file system on which the data repository association is configured.
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 Lustre file system with a data repository association.
default List<CfnTag>	getTags()	A list of Tag values, with a maximum of 50 elements.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataRepositoryPath

@Stability(Stable)
@NotNull
String getDataRepositoryPath()

The path to the Amazon S3 data repository that will be linked to the file system.

The path can be an S3 bucket or prefix in the format s3://bucket-name/prefix/ . This path specifies where in the S3 data repository files will be imported from or exported to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-datarepositorypath

getFileSystemId

@Stability(Stable)
@NotNull
String getFileSystemId()

The ID of the file system on which the data repository association is configured.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-filesystemid

getFileSystemPath

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-filesystempath

getBatchImportMetaDataOnCreate

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-batchimportmetadataoncreate

getImportedFileChunkSize

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-importedfilechunksize

getS3

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

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

The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-s3

getTags

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html#cfn-fsx-datarepositoryassociation-tags

builder

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

Returns:

a CfnDataRepositoryAssociationProps.Builder of CfnDataRepositoryAssociationProps