software.amazon.awscdk.services.fsx

Class CfnDataRepositoryAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.fsx.CfnDataRepositoryAssociation

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:41.594Z")
 @Stability(value=Stable)
public class CfnDataRepositoryAssociation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::FSx::DataRepositoryAssociation`.

Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported only for file systems with the Persistent_2 deployment type.

Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket .

CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.

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.*;
 CfnDataRepositoryAssociation cfnDataRepositoryAssociation = CfnDataRepositoryAssociation.Builder.create(this, "MyCfnDataRepositoryAssociation")
         .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	Class and Description
static interface	CfnDataRepositoryAssociation.AutoExportPolicyProperty Describes a data repository association's automatic export policy.
static interface	CfnDataRepositoryAssociation.AutoImportPolicyProperty Describes the data repository association's automatic import policy.
static class	CfnDataRepositoryAssociation.Builder A fluent builder for CfnDataRepositoryAssociation.
static interface	CfnDataRepositoryAssociation.S3Property Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDataRepositoryAssociation(Construct scope, String id, CfnDataRepositoryAssociationProps props) Create a new `AWS::FSx::DataRepositoryAssociation`.
protected	CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAssociationId()
String	getAttrResourceArn()
Object	getBatchImportMetaDataOnCreate() A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
protected Map<String,Object>	getCfnProperties()
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` .
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.
Object	getS3() The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.
TagManager	getTags() `AWS::FSx::DataRepositoryAssociation.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBatchImportMetaDataOnCreate(Boolean value) A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
void	setBatchImportMetaDataOnCreate(IResolvable value) A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
void	setDataRepositoryPath(String value) The path to the data repository that will be linked to the cache or file system.
void	setFileSystemId(String value) `AWS::FSx::DataRepositoryAssociation.FileSystemId`.
void	setFileSystemPath(String value) 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` .
void	setImportedFileChunkSize(Number value) 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.
void	setS3(CfnDataRepositoryAssociation.S3Property value) The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.
void	setS3(IResolvable value) The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDataRepositoryAssociation

protected CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataRepositoryAssociation

protected CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataRepositoryAssociation

@Stability(value=Stable)
public CfnDataRepositoryAssociation(@NotNull
                                                             Construct scope,
                                                             @NotNull
                                                             String id,
                                                             @NotNull
                                                             CfnDataRepositoryAssociationProps props)

Create a new `AWS::FSx::DataRepositoryAssociation`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAssociationId

@Stability(value=Stable)
 @NotNull
public String getAttrAssociationId()

getAttrResourceArn

@Stability(value=Stable)
 @NotNull
public String getAttrResourceArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getDataRepositoryPath

@Stability(value=Stable)
 @NotNull
public 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/ .

setDataRepositoryPath

@Stability(value=Stable)
public void setDataRepositoryPath(@NotNull
                                                           String value)

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
public String getFileSystemId()

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

setFileSystemId

@Stability(value=Stable)
public void setFileSystemId(@NotNull
                                                     String value)

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

getFileSystemPath

@Stability(value=Stable)
 @NotNull
public 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.

setFileSystemPath

@Stability(value=Stable)
public void setFileSystemPath(@NotNull
                                                       String value)

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

setBatchImportMetaDataOnCreate

@Stability(value=Stable)
public void setBatchImportMetaDataOnCreate(@Nullable
                                                                    Boolean value)

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.

setBatchImportMetaDataOnCreate

@Stability(value=Stable)
public void setBatchImportMetaDataOnCreate(@Nullable
                                                                    IResolvable value)

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

setImportedFileChunkSize

@Stability(value=Stable)
public void setImportedFileChunkSize(@Nullable
                                                              Number value)

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
public Object getS3()

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

setS3

@Stability(value=Stable)
public void setS3(@Nullable
                                           IResolvable value)

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

setS3

@Stability(value=Stable)
public void setS3(@Nullable
                                           CfnDataRepositoryAssociation.S3Property value)

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